Extensions API - GET an extension's instance

Lists properties of the specified instance of the ActiveGate 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}/instances/{configurationId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/{configurationId}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/{configurationId}

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

 path required
configurationId string

The ID of the configuration.

 path required

Response

Response codes

Code Description
200

Success

Response body

The ExtensionConfigurationDto object

Element Type Description
extensionId string

The ID of the extension.
enabled boolean

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

Allows to skip current configuration and use global one.
properties object

The list of extension parameters.

Each parameter is a key-value pair.
hostId string

The ID of the host on which the extension runs.
activeGate EntityShortRepresentation
endpointId string

The ID of the endpoint.
endpointName string

The name of the endpoint, displayed in Dynatrace.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.
name string

The name of the Dynatrace entity.
description string

A short description of the Dynatrace entity.