OneAgent monitoring configuration API - PUT configuration
This API is deprecated. Use the Settings API with the Monitoring (builtin:host.monitoring) schema instead.
Updates the monitoring configuration of OneAgent on the specified host.
The request consumes an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring |
Authentication
To execute this request, you need an access token with WriteConfig scope.
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 | 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 |
|---|---|---|---|
| autoInjectionEnabled | boolean | Code modules will be injected automatically into monitored applications if this setting is enabled. This setting won't apply if auto-injection is disabled via oneagentctl (see https://dt-url.net/oneagentctl). | optional |
| id | string | The Dynatrace entity ID of the host where OneAgent is deployed. | optional |
| metadata | Configuration | Metadata useful for debugging | 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 |
|---|---|---|---|
| clusterVersion | string | Dynatrace version. | optional |
| 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 |
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.
{"autoInjectionEnabled": true,"id": "HOST-0123456789ABCDE","metadata": {"clusterVersion": "1.192.1","configurationVersions": [4,2],"currentConfigurationVersions": ["1.0.4","1.23"]},"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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring/validator |
Authentication
To execute this request, you need an access token with WriteConfig scope.
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 |