OneAgent monitoring configuration API - PUT configuration
Updates the monitoring configuration of OneAgent on the specified host.
The request consumes an application/json payload.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring |
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 Dynatrace entity ID of the required host. | path | optional |
| body | Monitoring | The JSON body of the request. Contains OneAgent monitoring parameters. | body | optional |
Request body objects
The MonitoringConfig object
Monitoring configuration of OneAgent.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | 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 version numbers of the configuration. | optional |
| clusterVersion | string | Dynatrace version. | 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.
{
"metadata": {
"configurationVersions": [
4,
2
],
"currentConfigurationVersions": [
"1.0.4",
"1.23"
],
"clusterVersion": "1.192.1"
},
"id": "HOST-0123456789ABCDE",
"monitoringEnabled": true,
"monitoringMode": "FULL_STACK"
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The configuration has been updated. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid |
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 | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring/validator |
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.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted configuration is valid. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid |