Hub capabilities API - GET an extension 2.0
Gets the details about an extension 2.0.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/hub/extensions2/{extensionName} | |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName} |
Authentication
To execute this request, you need an access token with hub.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
extensionName | string | Fully qualified name of the extension | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | ItemDetails | OK |
400 | ErrorEnvelope | Bad request |
404 | ErrorEnvelope | Not found |
503 | ErrorEnvelope | Unavailable |
Response body objects
The ItemDetails
object
Public metadata for an item.
Element | Type | Description |
---|---|---|
authorLogo | string | Url for the author's logo. |
authorName | string | Name of the author of the item. |
clusterCompatible | boolean | Checks if the item is compatible with the cluster version. |
clusterMaxVersion | integer | The maximum supported cluster version for this item. |
clusterMinVersion | integer | The minimum cluster version required to use this item. |
description | string | Description of the item. |
descriptionBlocks | DescriptionBlock[] | - |
documentationLink | string | An absolute link to a documentation page explaining the item. |
extension1Details | Extension1Details | Additional details of the extension version 1. |
extension2Details | Extension2Details | Additional details of the extension. |
itemId | string | Unique Id of the item. |
logo | string | The logo of the item. Can be a URL or Base64 encoded. Intended for |
marketingLink | string | An absolute link to a marketing page promoting how the item can be used with dynatrace. |
name | string | Name of the item. |
notCompatibleReason | string | The reason why the item is not compatible with the cluster version. |
relatedItems | RelatedItem[] | Related items. |
tags | string[] | Grouping of items with keywords. |
technologyDetails | TechnologyDetails | Additional details of the technology. |
type | string | Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.
|
The DescriptionBlock
object
Represents a section of data describing the given capability.
Element | Type | Description |
---|---|---|
images | Image[] | Collection of images (in case of gallery). |
source | string | Source of the description block (in case of markdown). |
sourceId | string | Optional identifier of special description blocks. |
title | string | Title of the description block. |
type | string | Type of the data, either markdown or gallery.
|
The Image
object
Information about the image details of a capability.
Element | Type | Description |
---|---|---|
alt | string | Alternate text for the image. |
src | string | Url of the image. |
title | string | Title of the image. |
The Extension1Details
object
Additional details of the extension version 1.
Element | Type | Description |
---|---|---|
releases | Extension1Release[] | A list of versions for the extension version 1. |
The Extension1Release
object
Extension version 1 release details.
Element | Type | Description |
---|---|---|
artifactSha256 | string | SHA-256 hash of the extension version 1. |
artifactTitle | string | The title of the extension version 1. |
releaseNotes | string | The associated release notes. |
version | string | The version number of the extension version 1 release. |
The Extension2Details
object
Additional details of the extension.
Element | Type | Description |
---|---|---|
distributed | boolean | Whether this extension is available in the central hub catalog. |
extensionName | string | Fully qualified name of the extension. |
recommendedCatalogVersion | string | Recommended version of this extension to use. This is the latest compatible published release. |
releases | ExtensionRelease[] | Releases for the extension. |
The ExtensionRelease
object
Extensions releases information
Element | Type | Description |
---|---|---|
active | boolean | Represents whether this version is active version |
artifactSha256 | string | Sha256 hash for the distributed extension. |
assetsInfo | AssetInfo[] | Assets types and its count |
configuredFeatureSets | string[] | Configured feature sets for an installed release |
dataSources | string[] | Available data sources for the given release |
distributed | boolean | Represents whether the release is distributed |
featureSets | object | Feature sets contained in the given release |
minClusterVersion | integer | Minimum cluster version for the release |
registered | boolean | Represents whether extension is already registered |
releaseNotes | string | Release notes for the extension. |
unpublished | boolean | Represents whether the extension is unpublished. |
unpublishedDescription | string | The description why the extension was unpublished. |
unpublishedSeverity | integer | The severity of unpublished extension. 5 indicates an error state |
version | string | Version number of the extension. |
The AssetInfo
object
Assets types and its count
Element | Type | Description |
---|---|---|
assetType | string | - |
count | integer | - |
The FeatureSetDetails
object
Additional information about a Feature Set
Element | Type | Description |
---|---|---|
metrics | MetricDto[] | Feature set metrics |
The MetricDto
object
Metric gathered by an extension
Element | Type | Description |
---|---|---|
key | string | Metric key |
metadata | MetricMetadataDto | Metric metadata |
The MetricMetadataDto
object
Metric metadata
Element | Type | Description |
---|---|---|
description | string | A short description of the metric |
displayName | string | The name of the metric in the user interface |
unit | string | The unit of the metric |
The RelatedItem
object
Related items.
Element | Type | Description |
---|---|---|
description | string | - |
externalLink | string | External link (marketing/documentation) that can provide with additional information. |
hasClusterLink | boolean | Indicates whether there is a page within the product to activate this item. |
iconUrl | string | The logo of the item. Can be a URL or Base64 encoded. Intended for |
id | string | - |
name | string | - |
type | string | Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.
|
The TechnologyDetails
object
Additional details of the technology.
Element | Type | Description |
---|---|---|
activationLink | string | Represents the installation/public navigation link for the technology. |
Response body JSON model
1{2 "authorLogo": "string",3 "authorName": "string",4 "clusterCompatible": true,5 "clusterMaxVersion": 1,6 "clusterMinVersion": 1,7 "description": "string",8 "descriptionBlocks": [9 {10 "images": [11 {12 "alt": "string",13 "src": "string",14 "title": "string"15 }16 ],17 "source": "string",18 "sourceId": "string",19 "title": "string",20 "type": "GALLERY"21 }22 ],23 "documentationLink": "string",24 "extension1Details": {25 "releases": [26 {27 "artifactSha256": "string",28 "artifactTitle": "string",29 "releaseNotes": "string",30 "version": "string"31 }32 ]33 },34 "extension2Details": {35 "distributed": true,36 "extensionName": "string",37 "recommendedCatalogVersion": "string",38 "releases": [39 {40 "active": true,41 "artifactSha256": "string",42 "assetsInfo": [43 {44 "assetType": "string",45 "count": 146 }47 ],48 "configuredFeatureSets": [49 "string"50 ],51 "dataSources": [52 "string"53 ],54 "distributed": true,55 "featureSets": {},56 "minClusterVersion": 1,57 "registered": true,58 "releaseNotes": "string",59 "unpublished": true,60 "unpublishedDescription": "string",61 "unpublishedSeverity": 1,62 "version": "string"63 }64 ]65 },66 "itemId": "string",67 "logo": "string",68 "marketingLink": "string",69 "name": "string",70 "notCompatibleReason": "string",71 "relatedItems": [72 {73 "description": "string",74 "externalLink": "string",75 "hasClusterLink": true,76 "iconUrl": "string",77 "id": "string",78 "name": "string",79 "type": "EXTENSION1"80 }81 ],82 "tags": [83 "string"84 ],85 "technologyDetails": {86 "activationLink": "string"87 },88 "type": "EXTENSION1"89}