Extensions API - PUT an extension's instance

Updates properties of the specified instance of the extension.

The request consumes an application/json payload.

Early Adopter

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

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


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


Parameter Type Description In Required
id string

The ID of the extension where you want to update the configuration.

If you set the extension ID in the body as well, it must match this ID.

path required
configurationId string

The ID of the configuration to be updated.

path required
body ExtensionConfigurationDto

The JSON body of the request. Contains updated parameters of the extension configuration.

body optional

Body format

The ExtensionConfigurationDto object

Element Type Description Required
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 optional
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 Required
id string

The ID of the Dynatrace entity.



Response codes

Code Description

Success. The configuration has been updated. Response doesn't have a body.


Failed. The input is invalid

Response body

A successful request doesn't return any content.