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 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
monitoringEnabled boolean

The monitoring is enabled (true) or disabled (false).

required
monitoringMode string

The monitoring mode for the host: full stack or infrastructure only.

required

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
  • 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 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.