Extensions API - PUT global configuration
Updates the global configuration of the specified OneAgent or JMX extension.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| PUT | Managed | 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 Write configuration (WriteConfig) permission assigned to your API token. 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 | optional |
| body | Global | 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 |
|---|---|---|---|
| extensionId | string | The ID of the extension. | optional |
| enabled | boolean | The extension is enabled ( | required |
| infraOnlyEnabled | boolean | The plugin is enabled ( | 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": [
{
"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
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. Extension configuration has been updated. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid |