• Home
  • Dynatrace API
  • Configuration
  • Extensions
  • GET an extension

Extensions API - GET an extension

Lists the properties of the specified extension.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required extension.

pathrequired

Response

Response codes

CodeTypeDescription
200Extension

Success

Response body objects

The Extension object

General configuration of an extension.

ElementTypeDescription
idstring

The ID of the extension, for example custom.remote.python.demo.

namestring

The name of the extension, displayed in Dynatrace.

versionstring

The version of the extension, displayed in Dynatrace.

typestring

The type of the extension. It indicates the runtime environment of the extension (for example, ACTIVEGATE).

The element can hold these values
  • ACTIVEGATE
  • CODEMODULE
  • JMX
  • ONEAGENT
  • PMI
  • UNKNOWN
metricGroupstring

The metricGroup of the extension used for grouping custom metrics into a hierarchical namespace.

metadataConfigurationMetadata

Metadata useful for debugging

propertiesExtensionProperty[]

A list of extension properties.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

The ExtensionProperty object

A property of an extension.

ElementTypeDescription
keystring

The key of the property.

typestring

The type of the property.

defaultValuestring

The default value of the property.

dropdownValuesstring[]

The list of possible values of the property.

If such a list is defined, only values from this list can be assigned to the property.

Response body JSON model

json
{ "id": "custom.remote.python.demo", "name": "ActiveGate demo extension", "version": "1.01", "type": "ActiveGate", "metricGroup": "custom.demo_metrics", "metadata": { "configurationVersions": [ 7 ], "clusterVersion": "1.186.0.20200109-094111" }, "properties": [ { "key": "serverIp", "type": "STRING", "defaultValue": "127.0.0.1" }, { "key": "password", "type": "PASSWORD", "defaultValue": "" }, { "key": "username", "type": "STRING", "defaultValue": "dynatrace" }, { "key": "dropdownProperty", "type": "DROPDOWN", "defaultValue": "one", "dropdownValues": [ "one", "two", "three" ] } ] }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.