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

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

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

body
optional

Request body objects

The ExtensionConfigurationDto object

Element
Type
Description
Required
activeGate

The short representation of a Dynatrace entity.

optional
enabled
boolean

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

required
endpointId
string

The ID of the endpoint.

optional
endpointName
string

The name of the endpoint, displayed in Dynatrace.

optional
extensionId
string

The ID of the extension.

optional
hostId
string

The ID of the host on which the extension runs.

optional
properties
object

The list of extension parameters.

Each parameter is a key-value pair.

optional
useGlobal
boolean

Allows to skip current configuration and use global one.

required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
Required
description
string

A short description of the Dynatrace entity.

optional
id
string

The ID of the Dynatrace entity.

required
name
string

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

Code
Type
Description
204
-

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

400

Failed. The input is invalid

Related topics