Extensions API - PUT an extension's instance

Updates properties of the specified instance of the extension.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/{configurationId}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/{configurationId}

Authentication

To execute this request, you need an access token with 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

ElementTypeDescriptionRequired
activeGateEntityShortRepresentation

The short representation of a Dynatrace entity.

optional
enabledboolean

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

required
endpointIdstring

The ID of the endpoint.

optional
endpointNamestring

The name of the endpoint, displayed in Dynatrace.

optional
extensionIdstring

The ID of the extension.

optional
hostIdstring

The ID of the host on which the extension runs.

optional
propertiesobject

The list of extension parameters.

Each parameter is a key-value pair.

optional
useGlobalboolean

Allows to skip current configuration and use global one.

required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescriptionRequired
descriptionstring

A short description of the Dynatrace entity.

optional
idstring

The ID of the Dynatrace entity.

required
namestring

The name of the Dynatrace entity.

optional

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.

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

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid