Hub capabilities API - GET an extension v1

Gets the details about a version 1 extension.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/hub/extensions1/{extension1FQN}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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

ParameterTypeDescriptionInRequired
extension1FQNstring

Fully qualified name of the extension1/plugin

pathrequired

Response

Response codes

CodeTypeDescription
200ItemDetails

OK

404ErrorEnvelope

Not found

503ErrorEnvelope

Unavailable

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ItemDetails object

Public metadata for an item.

ElementTypeDescription
authorLogostring

Url for the author's logo.

authorNamestring

Name of the author of the item.

clusterCompatibleboolean

Checks if the item is compatible with the cluster version.

clusterMaxVersioninteger

The maximum supported cluster version for this item.

clusterMinVersioninteger

The minimum cluster version required to use this item.

descriptionstring

Description of the item.

descriptionBlocksDescriptionBlock[]-
documentationLinkstring

An absolute link to a documentation page explaining the item.

extension1DetailsExtension1Details

Additional details of the extension version 1.

extension2DetailsExtension2Details

Additional details of the extension.

itemIdstring

Unique Id of the item.

logostring

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

marketingLinkstring

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

namestring

Name of the item.

notCompatibleReasonstring

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

relatedItemsRelatedItem[]

Related items.

tagsstring[]

Grouping of items with keywords.

technologyDetailsTechnologyDetails

Additional details of the technology.

typestring

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

  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY

The DescriptionBlock object

Represents a section of data describing the given capability.

ElementTypeDescription
imagesImage[]

Collection of images (in case of gallery).

sourcestring

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

sourceIdstring

Optional identifier of special description blocks.

titlestring

Title of the description block.

typestring

Type of the data, either markdown or gallery.

  • GALLERY
  • MARKDOWN

The Image object

Information about the image details of a capability.

ElementTypeDescription
altstring

Alternate text for the image.

srcstring

Url of the image.

titlestring

Title of the image.

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
artifactSha256string

SHA-256 hash of the extension version 1.

artifactTitlestring

The title of the extension version 1.

releaseNotesstring

The associated release notes.

versionstring

The version number of the extension version 1 release.

The Extension2Details object

Additional details of the extension.

ElementTypeDescription
distributedboolean

Whether this extension is available in the central hub catalog.

extensionNamestring

Fully qualified name of the extension.

recommendedCatalogVersionstring

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

releasesExtensionRelease[]

Releases for the extension.

The ExtensionRelease object

Extensions releases information

ElementTypeDescription
activeboolean

Represents whether this version is active version

artifactSha256string

Sha256 hash for the distributed extension.

assetsInfoAssetInfo[]

Assets types and its count

configuredFeatureSetsstring[]

Configured feature sets for an installed release

dataSourcesstring[]

Available data sources for the given release

distributedboolean

Represents whether the release is distributed

featureSetsobject

Feature sets contained in the given release

minClusterVersioninteger

Minimum cluster version for the release

registeredboolean

Represents whether extension is already registered

releaseNotesstring

Release notes for the extension.

unpublishedboolean

Represents whether the extension is unpublished.

unpublishedDescriptionstring

The description why the extension was unpublished.

unpublishedSeverityinteger

The severity of unpublished extension. 5 indicates an error state

versionstring

Version number of the extension.

The AssetInfo object

Assets types and its count

ElementTypeDescription
assetTypestring-
countinteger-

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
descriptionstring

A short description of the metric

displayNamestring

The name of the metric in the user interface

unitstring

The unit of the metric

The RelatedItem object

Related items.

ElementTypeDescription
descriptionstring-
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.

iconUrlstring

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

idstring-
namestring-
typestring

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

  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY

The TechnologyDetails object

Additional details of the technology.

ElementTypeDescription
activationLinkstring

Represents the installation/public navigation link for the technology.

Response body JSON model

{
"authorLogo": "string",
"authorName": "string",
"clusterCompatible": true,
"clusterMaxVersion": 1,
"clusterMinVersion": 1,
"description": "string",
"descriptionBlocks": [
{
"images": [
{
"alt": "string",
"src": "string",
"title": "string"
}
],
"source": "string",
"sourceId": "string",
"title": "string",
"type": "GALLERY"
}
],
"documentationLink": "string",
"extension1Details": {
"releases": [
{
"artifactSha256": "string",
"artifactTitle": "string",
"releaseNotes": "string",
"version": "string"
}
]
},
"extension2Details": {
"distributed": true,
"extensionName": "string",
"recommendedCatalogVersion": "string",
"releases": [
{
"active": true,
"artifactSha256": "string",
"assetsInfo": [
{
"assetType": "string",
"count": 1
}
],
"configuredFeatureSets": [
"string"
],
"dataSources": [
"string"
],
"distributed": true,
"featureSets": {},
"minClusterVersion": 1,
"registered": true,
"releaseNotes": "string",
"unpublished": true,
"unpublishedDescription": "string",
"unpublishedSeverity": 1,
"version": "string"
}
]
},
"itemId": "string",
"logo": "string",
"marketingLink": "string",
"name": "string",
"notCompatibleReason": "string",
"relatedItems": [
{
"description": "string",
"externalLink": "string",
"hasClusterLink": true,
"iconUrl": "string",
"id": "string",
"name": "string",
"type": "EXTENSION1"
}
],
"tags": [
"string"
],
"technologyDetails": {
"activationLink": "string"
},
"type": "EXTENSION1"
}