OneAgent monitoring configuration API - PUT configuration
Updates the monitoring configuration of OneAgent on the specified host.
The request consumes an application/json
payload.
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 Dynatrace entity ID of the required host. |
path | required |
body | MonitoringConfig |
The JSON body of the request. Contains OneAgent monitoring parameters. |
body | optional |
Body format
The MonitoringConfig object
Monitoring configuration of OneAgent.
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata | optional | |
id | string |
The Dynatrace entity ID of the host where OneAgent is deployed. |
optional |
monitoringEnabled | boolean |
The monitoring is enabled ( |
required |
monitoringMode | string |
The monitoring mode for the host: full stack or infrastructure only. |
required |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
configurationVersions | integer[] |
A Sorted list of the version numbers of the configuration. |
optional |
currentConfigurationVersions | string[] |
A Sorted list of string version numbers of the configuration. |
optional |
clusterVersion | string |
Dynatrace server version. |
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.
{
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"id": "HOST-0123456789ABCDE",
"monitoringEnabled": true,
"monitoringMode": "FULL_STACK"
}
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.
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
POST |
|
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.
Response
Response codes
Code | Description |
---|---|
204 | Validated. The submitted configuration is valid. Response doesn't have a body. |
400 | Failed. The input is invalid |
Response body
A successful request doesn't return any content.