• Home
  • Dynatrace API
  • Configuration
  • Extensions
  • PUT global configuration

Extensions API - PUT global configuration

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

The request produces 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}/global
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/global
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/global

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

pathrequired
bodyGlobalExtensionConfiguration

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

bodyoptional

Request body objects

The GlobalExtensionConfiguration object

Global Configuration of OneAgent and JMX extension

ElementTypeDescription
extensionIdstring

The ID of the extension.

Can be null.

enabledboolean

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

infraOnlyEnabledboolean

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

Can be null.

propertiesobject

The list of configuration parameters.

Each parameter is a key-value pair.

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", "properties": [ { "key": "serverIp", "type": "STRING", "defaultValue": "127.0.0.1" }, { "key": "password", "type": "PASSWORD", "defaultValue": "" }, { "key": "username", "type": "STRING", "defaultValue": "dynatrace" }, { "key": "dropdownProperty", "type": "DROPDOWN", "defaultValue": "one", "dropdownValues": [ "one", "two", "three" ] } ] }

Response

Response codes

CodeTypeDescription
204-

Success. Extension 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.