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

Extensions API - GET an extension's instance

Lists properties of the specified instance of the ActiveGate extension.

The request produces an application/json payload.

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

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 extension.

pathrequired
configurationIdstring

The ID of the configuration.

pathrequired

Response

Response codes

CodeTypeDescription
200ExtensionConfigurationDto

Success

Response body objects

The ExtensionConfigurationDto object

ElementTypeDescription
extensionIdstring

The ID of the extension.

enabledboolean

The extension is enabled (true) or disabled (false).

useGlobalboolean

Allows to skip current configuration and use global one.

propertiesobject

The list of extension parameters.

Each parameter is a key-value pair.

hostIdstring

The ID of the host on which the extension runs.

activeGateEntityShortRepresentation

The short representation of a Dynatrace entity.

endpointIdstring

The ID of the endpoint.

endpointNamestring

The name of the endpoint, displayed in Dynatrace.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "id": "custom.remote.python.demo", "enabled": true, "useGlobal": false, "hostId": "HOST-01A7DEFA5340A86D", "properties": { "serverIp": "127.0.0.1", "username": "dynatrace", "password": "", "dropdownProperty": "three" }, "activeGate": { "id": "7835970235169136995", "name": "ActiveGate Host Name" } }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.