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

Parameter
Type
Description
In
Required
extension1FQN
string

Fully qualified name of the extension1/plugin

path
required

Response

Response codes

Code
Type
Description
200

OK

404

Not found

503

Unavailable

4XX

Client side error.

5XX

Server side error.

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
-
documentationLink
string

An absolute link to a documentation page explaining the item.

extension1Details

Additional details of the extension version 1.

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 html tags.

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

Related items.

tags
string[]

Grouping of items with keywords.

technologyDetails

Additional details of the technology.

type
string

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.

Element
Type
Description
images

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.

  • GALLERY
  • MARKDOWN

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

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

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

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

Feature set metrics

The MetricDto object

Metric gathered by an extension

Element
Type
Description
key
string

Metric key

metadata

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 html tags

id
string
-
name
string
-
type
string

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

  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY

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

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