Extensions 2.0 API - GET an extension

Lists the properties of the specified Extensions 2.0 extension or downloads the extension's ZIP file.

The request produces one of the following types of payload, depending on the value of the Accept request header:

  • application/json—a JSON payload containing properties of the extension.
  • application/octet-stream—a download of the ZIP file of the extension.

If no Accept header is provided with the request, an application/json payload is returned.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{extensionVersion}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}

Authentication

To execute this request, you need an access token with extensions.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
extensionNamestring

The name of the requested extension 2.0.

pathrequired
extensionVersionstring

The version of the requested extension 2.0

pathrequired
Acceptstring

Accept header. Specifies part of the extension 2.0 that will be returned:

  • application/json; charset=utf-8 - returns extension 2.0 metadata in JSON
  • application/octet-stream - returns extension 2.0 zip package stored on the server.
headeroptional

Response

Response codes

CodeTypeDescription
200Extension

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The Extension object

ElementTypeDescription
authorAuthorDto

Extension author

dataSourcesstring[]

Data sources that extension uses to gather data

extensionNamestring

Extension name

featureSetsstring[]

Available feature sets

featureSetsDetailsobject

Details of feature sets

fileHashstring

SHA-256 hash of uploaded Extension file

minDynatraceVersionstring

Minimal Dynatrace version that works with the extension

minEECVersionstring

Minimal Extension Execution Controller version that works with the extension

variablesstring[]

Custom variables used in extension configuration

versionstring

Extension version

The AuthorDto object

Extension author

ElementTypeDescription
namestring

Author name

The FeatureSetDetails object

Additional information about a Feature Set

ElementTypeDescription
descriptionstring

Optional description for the feature set

displayNamestring

Optional display name of the feature set

isRecommendedboolean

Marks the feature set as recommended (selected by default during activation)

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

Response body JSON model

{
  "author": {
    "name": "string"
  },
  "dataSources": [
    "string"
  ],
  "extensionName": "string",
  "featureSets": [
    "string"
  ],
  "featureSetsDetails": {},
  "fileHash": "string",
  "minDynatraceVersion": "string",
  "minEECVersion": "string",
  "variables": [
    "string"
  ],
  "version": "1.2.3"
}