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 |
|
Authentication
To execute this request, you need the 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 | required |
body | GlobalExtensionConfiguration |
The JSON body of the request. Contains updated configuration of the extension. |
body | optional |
Body format
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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample 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 | Description |
---|---|
204 | Success. Extension configuration has been updated. Response doesn't have a body. |
400 | Failed. The input is invalid |
Response body
A successful request doesn't return any content.