Extensions API - GET an extension

Lists the properties of the specified extension.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the required extension.

 path required

Response

Response codes

Code Description
200

Success

Response body

The Extension object

General configuration of an extension.

Element Type Description
id string

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

The name of the extension, displayed in Dynatrace.
version string

The version of the extension, displayed in Dynatrace.
type string

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

The metricGroup of the extension used for grouping custom metrics into a hierarchical namespace.
metadata ConfigurationMetadata
properties ExtensionProperty[]

A list of extension properties.

The ExtensionProperty object

A property of an extension.

Element Type Description
key string

The key of the property.
type string

The type of the property.
defaultValue string

The default value of the property.
dropdownValues string[]

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.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
clusterVersion string

Dynatrace version.
currentConfigurationVersions string[]

A sorted list of version numbers of the configuration.
configurationVersions integer[]

A sorted list of the version numbers of the configuration.