Extensions API - PUT an extension's instance
Updates properties of the specified instance of the extension.
The request consumes 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 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 | ExtensionConfigurationDto |
The JSON body of the request. Contains updated parameters of the extension configuration. |
body | optional |
Body format
The ExtensionConfigurationDto object
Element | Type | Description | Required |
---|---|---|---|
extensionId | string |
The ID of the extension. |
optional |
enabled | boolean |
The extension is enabled ( |
required |
useGlobal | boolean |
Allows to skip current configuration and use global one. |
required |
properties | object |
The list of extension parameters. Each parameter is a key-value pair. |
optional |
hostId | string |
The ID of the host on which the extension runs. |
optional |
activeGate | EntityShortRepresentation | optional | |
endpointId | string |
The ID of the endpoint. |
optional |
endpointName | string |
The name of the endpoint, displayed in Dynatrace. |
optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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",
"enabled": true,
"useGlobal": false,
"hostId": "HOST-01A7DEFA5340A86D",
"properties": {
"serverIp": "127.0.0.1",
"username": "dynatrace",
"password": "",
"dropdownProperty": "three"
},
"activeGate": {
"id": "7835970235169136995",
"name": "ActiveGate Host Name"
}
}
Response
Response codes
Code | Description |
---|---|
204 | Success. The 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.