• Home
  • Dynatrace API
  • Environment
  • Extensions 2.0
  • Extensions
  • GET an extension

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.

GETManaged https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{extensionVersion}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}

Authentication

To execute this request, you need an access token with Read extensions (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

404ErrorEnvelope

Failed. The requested resource doesn't exist.

406ErrorEnvelope

Not acceptable

Response body objects

The Extension object

ElementTypeDescription
extensionNamestring

Extension name

Can be null.

versionstring

Extension version

Can be null.

authorAuthorDto

Extension author

Can be null.

dataSourcesstring[]

Data sources that extension uses to gather data

Can be null.

variablesstring[]

Custom variables used in extension configuration

Can be null.

featureSetsstring[]

Available feature sets

Can be null.

featureSetsDetailsobject

Details of feature sets

Can be null.

minDynatraceVersionstring

Minimal Dynatrace version that works with the extension

Can be null.

fileHashstring

SHA-256 hash of uploaded Extension file

Can be null.

The AuthorDto object

Extension author

ElementTypeDescription
namestring

Author name

Can be null.

The FeatureSetDetails object

Additional information about a Feature Set

ElementTypeDescription
metricsMetricDto[]

Feature set metrics

Can be null.

The MetricDto object

Metric gathered by an extension

ElementTypeDescription
keystring

Metric key

Can be null.

Response body JSON model

json
{ "extensionName": "string", "version": "1.2.3", "author": { "name": "string" }, "dataSources": [ "string" ], "variables": [ "string" ], "featureSets": [ "string" ], "featureSetsDetails": {}, "minDynatraceVersion": "string", "fileHash": "string" }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.