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

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.

PUTManaged 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 an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

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.

pathrequired
configurationIdstring

The ID of the configuration to be updated.

pathrequired
bodyExtensionConfigurationDto

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

bodyoptional

Request body objects

The ExtensionConfigurationDto object

ElementTypeDescription
extensionIdstring

The ID of the extension.

Can be null.

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.

Can be null.

hostIdstring

The ID of the host on which the extension runs.

Can be null.

activeGateEntityShortRepresentation

The short representation of a Dynatrace entity.

Can be null.

endpointIdstring

The ID of the endpoint.

Can be null.

endpointNamestring

The name of the endpoint, displayed in Dynatrace.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

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

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid

Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.