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

Parameter
Type
Description
In
Required
extensionName
string

The name of the requested extension 2.0.

path
required
extensionVersion
string

The version of the requested extension 2.0

path
required
Accept
string

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.
header
optional

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The Extension object

Element
Type
Description
author

Extension author

dataSources
string[]

Data sources that extension uses to gather data

extensionName
string

Extension name

featureSets
string[]

Available feature sets

featureSetsDetails
object

Details of feature sets

fileHash
string

SHA-256 hash of uploaded Extension file

minDynatraceVersion
string

Minimal Dynatrace version that works with the extension

minEECVersion
string

Minimal Extension Execution Controller version that works with the extension

variables
string[]

Custom variables used in extension configuration

version
string

Extension version

The AuthorDto object

Extension author

Element
Type
Description
name
string

Author name

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

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

Related topics