• Home
  • Dynatrace API
  • Environment
  • Hub items
  • GET an extension 2.0

Hub capabilities API - GET an extension 2.0

Gets the details about an extension 2.0.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/hub/extensions2/{extensionName}
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
extensionNamestring

Fully qualified name of the extension

pathrequired

Response

Response codes

CodeTypeDescription
200ItemDetails

OK

400ErrorEnvelope

Bad request

404ErrorEnvelope

Not found

503ErrorEnvelope

Unavailable

Response body objects

The ItemDetails object

Public metadata for an item.

ElementTypeDescription
typestring

Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.

The element can hold these values
  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY
itemIdstring

Unique Id of the item.

namestring

Name of the item.

descriptionstring

Description of the item.

tagsstring[]

Grouping of items with keywords.

authorNamestring

Name of the author of the item.

authorLogostring

Url for the author's logo.

clusterCompatibleboolean

Checks if the item is compatible with the cluster version.

clusterMinVersioninteger

The minimum cluster version required to use this item.

clusterMaxVersioninteger

The maximum supported cluster version for this item.

notCompatibleReasonstring

The reason why the item is not compatible with the cluster version.

descriptionBlocksDescriptionBlock[]-
documentationLinkstring

An absolute link to a documentation page explaining the item.

marketingLinkstring

An absolute link to a marketing page promoting how the item can be used with dynatrace.

technologyDetailsTechnologyDetails

Additional details of the technology.

extension1DetailsExtension1Details

Additional details of the extension version 1.

extension2DetailsExtension2Details

Additional details of the extension.

logostring

The logo of the item. Can be a URL or Base64 encoded. Intended for html tags.

relatedItemsRelatedItem[]

Related items.

The DescriptionBlock object

Represents a section of data describing the given capability.

ElementTypeDescription
typestring

Type of the data, either markdown or gallery.

The element can hold these values
  • GALLERY
  • MARKDOWN
titlestring

Title of the description block.

sourcestring

Source of the description block (in case of markdown).

imagesImage[]

Collection of images (in case of gallery).

sourceIdstring

Optional identifier of special description blocks.

The Image object

Information about the image details of a capability.

ElementTypeDescription
titlestring

Title of the image.

altstring

Alternate text for the image.

srcstring

Url of the image.

The TechnologyDetails object

Additional details of the technology.

ElementTypeDescription
activationLinkstring

Represents the installation/public navigation link for the technology.

The Extension1Details object

Additional details of the extension version 1.

ElementTypeDescription
releasesExtension1Release[]

A list of versions for the extension version 1.

The Extension1Release object

Extension version 1 release details.

ElementTypeDescription
versionstring

The version number of the extension version 1 release.

artifactTitlestring

The title of the extension version 1.

artifactSha256string

SHA-256 hash of the extension version 1.

releaseNotesstring

The associated release notes.

The Extension2Details object

Additional details of the extension.

ElementTypeDescription
recommendedCatalogVersionstring

Recommended version of this extension to use. This is the latest compatible published release.

extensionNamestring

Fully qualified name of the extension.

releasesExtensionRelease[]

Releases for the extension.

The ExtensionRelease object

Extensions releases information

ElementTypeDescription
versionstring

Version number of the extension.

artifactSha256string

Sha256 hash for the distributed extension.

releaseNotesstring

Release notes for the extension.

unpublishedDescriptionstring

The description why the extension was unpublished.

unpublishedSeverityinteger

The severity of unpublished extension. 5 indicates an error state

featureSetsobject

Feature sets contained in the given release

dataSourcesstring[]

Available data sources for the given release

configuredFeatureSetsstring[]

Configured feature sets for an installed release

minClusterVersioninteger-
assetsInfoAssetInfo[]

Assets types and its count

activeboolean

Represents whether this version is active version

distributedboolean-
unpublishedboolean-
registeredboolean-

The FeatureSetDetails object

Additional information about a Feature Set

ElementTypeDescription
metricsMetricDto[]

Feature set metrics

The MetricDto object

Metric gathered by an extension

ElementTypeDescription
keystring

Metric key

metadataMetricMetadataDto

Metric metadata

The MetricMetadataDto object

Metric metadata

ElementTypeDescription
displayNamestring

The name of the metric in the user interface

descriptionstring

A short description of the metric

unitstring

The unit of the metric

The AssetInfo object

Assets types and its count

ElementTypeDescription
assetTypestring-
countinteger-

The RelatedItem object

Related items.

ElementTypeDescription
typestring

Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.

The element can hold these values
  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY
idstring-
namestring-
descriptionstring-
iconUrlstring-
externalLinkstring

External link (marketing/documentation) that can provide with additional information.

hasClusterLinkboolean

Indicates whether there is a page within the product to activate this item.

Response body JSON model

json
{ "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 } ] }