Extensions API - PUT global configuration

Updates the global configuration of the specified OneAgent or JMX extension.

The request produces an application/json payload.

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

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 to be updated.

path
required
body

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

body
optional

Request body objects

The GlobalExtensionConfiguration object

Global Configuration of OneAgent and JMX extension

Element
Type
Description
Required
enabled
boolean

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

required
extensionId
string

The ID of the extension.

optional
infraOnlyEnabled
boolean

The plugin is enabled (true) or disabled (false) globally for hosts in infrastructure-only monitoring mode

optional
properties
object

The list of configuration parameters.

Each parameter is a key-value pair.

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.

{
  "id": "custom.remote.python.demo",
  "properties": [
    {
      "defaultValue": "127.0.0.1",
      "key": "serverIp",
      "type": "STRING"
    },
    {
      "defaultValue": "",
      "key": "password",
      "type": "PASSWORD"
    },
    {
      "defaultValue": "dynatrace",
      "key": "username",
      "type": "STRING"
    },
    {
      "defaultValue": "one",
      "dropdownValues": [
        "one",
        "two",
        "three"
      ],
      "key": "dropdownProperty",
      "type": "DROPDOWN"
    }
  ]
}

Response

Response codes

Code
Type
Description
204
-

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

400

Failed. The input is invalid

Related topics