Hub capabilities API - GET an extension v1
Gets the details about a version 1 extension.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/hub/extensions1/{extension1FQN} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/hub/extensions1/{extension1FQN} | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/hub/extensions1/{extension1FQN} |
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 |
---|---|---|---|---|
extension1FQN | string | Fully qualified name of the extension1/plugin | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Item | OK |
404 | ErrorEnvelope | Not found |
503 | ErrorEnvelope | Unavailable |
Response body objects
The ItemDetails
object
Public metadata for an item.
Element | Type | Description |
---|---|---|
type | string | Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2. |
itemId | string | Unique Id of the item. |
name | string | Name of the item. |
description | string | Description of the item. |
tags | string[] | Grouping of items with keywords. |
authorName | string | Name of the author of the item. |
authorLogo | string | Url for the author's logo. |
clusterCompatible | boolean | Checks if the item is compatible with the cluster version. |
clusterMinVersion | integer | The minimum cluster version required to use this item. |
clusterMaxVersion | integer | The maximum supported cluster version for this item. |
notCompatibleReason | string | The reason why the item is not compatible with the cluster version. |
descriptionBlocks | Description | - |
documentationLink | string | An absolute link to a documentation page explaining the item. |
marketingLink | string | An absolute link to a marketing page promoting how the item can be used with dynatrace. |
technologyDetails | Technology | Additional details of the technology. |
extension1Details | Extension1 | Additional details of the extension version 1. |
extension2Details | Extension2 | Additional details of the extension. |
logo | string | The logo of the item. Can be a URL or Base64 encoded. Intended for |
relatedItems | Related | Related items. |
The DescriptionBlock
object
Represents a section of data describing the given capability.
Element | Type | Description |
---|---|---|
type | string | Type of the data, either markdown or gallery. |
title | string | Title of the description block. |
source | string | Source of the description block (in case of markdown). |
images | Image[] | Collection of images (in case of gallery). |
sourceId | string | Optional identifier of special description blocks. |
The Image
object
Information about the image details of a capability.
Element | Type | Description |
---|---|---|
title | string | Title of the image. |
alt | string | Alternate text for the image. |
src | string | Url of the image. |
The TechnologyDetails
object
Additional details of the technology.
Element | Type | Description |
---|---|---|
activationLink | string | Represents the installation/public navigation link for the technology. |
The Extension1Details
object
Additional details of the extension version 1.
Element | Type | Description |
---|---|---|
releases | Extension1 | A list of versions for the extension version 1. |
The Extension1Release
object
Extension version 1 release details.
Element | Type | Description |
---|---|---|
version | string | The version number of the extension version 1 release. |
artifactTitle | string | The title of the extension version 1. |
artifactSha256 | string | SHA-256 hash of the extension version 1. |
releaseNotes | string | The associated release notes. |
The Extension2Details
object
Additional details of the extension.
Element | Type | Description |
---|---|---|
recommendedCatalogVersion | string | Recommended version of this extension to use. This is the latest compatible published release. |
extensionName | string | Fully qualified name of the extension. |
releases | Extension | Releases for the extension. |
The ExtensionRelease
object
Extensions releases information
Element | Type | Description |
---|---|---|
version | string | Version number of the extension. |
artifactSha256 | string | Sha256 hash for the distributed extension. |
releaseNotes | string | Release notes for the extension. |
unpublishedDescription | string | The description why the extension was unpublished. |
unpublishedSeverity | integer | The severity of unpublished extension. 5 indicates an error state |
featureSets | object | Feature sets contained in the given release |
dataSources | string[] | Available data sources for the given release |
configuredFeatureSets | string[] | Configured feature sets for an installed release |
minClusterVersion | integer | - |
assetsInfo | Asset | Assets types and its count |
active | boolean | Represents whether this version is active version |
distributed | boolean | - |
unpublished | boolean | - |
registered | boolean | - |
The FeatureSetDetails
object
Additional information about a Feature Set
Element | Type | Description |
---|---|---|
metrics | Metric | Feature set metrics |
The MetricDto
object
Metric gathered by an extension
Element | Type | Description |
---|---|---|
key | string | Metric key |
metadata | Metric | Metric metadata |
The MetricMetadataDto
object
Metric metadata
Element | Type | Description |
---|---|---|
displayName | string | The name of the metric in the user interface |
description | string | A short description of the metric |
unit | string | The unit of the metric |
The AssetInfo
object
Assets types and its count
Element | Type | Description |
---|---|---|
assetType | string | - |
count | integer | - |
The RelatedItem
object
Related items.
Element | Type | Description |
---|---|---|
type | string | Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2. |
id | string | - |
name | string | - |
description | string | - |
iconUrl | 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. |
Response body JSON model
{
"type": "EXTENSION1",
"itemId": "string",
"name": "string",
"description": "string",
"tags": [
"string"
],
"authorName": "string",
"authorLogo": "string",
"clusterCompatible": true,
"clusterMinVersion": 1,
"clusterMaxVersion": 1,
"notCompatibleReason": "string",
"descriptionBlocks": [
{
"type": "GALLERY",
"title": "string",
"source": "string",
"images": [
{
"title": "string",
"alt": "string",
"src": "string"
}
],
"sourceId": "string"
}
],
"documentationLink": "string",
"marketingLink": "string",
"technologyDetails": {
"activationLink": "string"
},
"extension1Details": {
"releases": [
{
"version": "string",
"artifactTitle": "string",
"artifactSha256": "string",
"releaseNotes": "string"
}
]
},
"extension2Details": {
"recommendedCatalogVersion": "string",
"extensionName": "string",
"releases": [
{
"version": "string",
"artifactSha256": "string",
"releaseNotes": "string",
"unpublishedDescription": "string",
"unpublishedSeverity": 1,
"featureSets": {},
"dataSources": [
"string"
],
"configuredFeatureSets": [
"string"
],
"minClusterVersion": 1,
"assetsInfo": [
{
"assetType": "string",
"count": 1
}
],
"active": true,
"distributed": true,
"unpublished": true,
"registered": true
}
]
},
"logo": "string",
"relatedItems": [
{
"type": "EXTENSION1",
"id": "string",
"name": "string",
"description": "string",
"iconUrl": "string",
"externalLink": "string",
"hasClusterLink": true
}
]
}