• Home
  • Dynatrace API
  • Configuration
  • OneAgent configuration
  • On a host
  • Monitoring configuration
  • PUT configuration

OneAgent monitoring configuration API - PUT configuration

Updates the monitoring configuration of OneAgent on the specified host.

The request consumes an application/json payload.

PUTManaged 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 an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The Dynatrace entity ID of the required host.

pathrequired
bodyMonitoringConfig

The JSON body of the request. Contains OneAgent monitoring parameters.

bodyoptional

Request body objects

The MonitoringConfig object

Monitoring configuration of OneAgent.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

Can be null.

idstring

The Dynatrace entity ID of the host where OneAgent is deployed.

Can be null.

monitoringEnabledboolean

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

monitoringModestring

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

The element can hold these values
  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
autoInjectionEnabledboolean

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

Can be null.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersionstring

Dynatrace version.

Can be null.

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.

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "currentConfigurationVersions": [ "1.0.4", "1.23" ], "clusterVersion": "1.192.1" }, "id": "HOST-0123456789ABCDE", "monitoringEnabled": true, "monitoringMode": "FULL_STACK", "autoInjectionEnabled": true }

Response

Response codes

CodeTypeDescription
204-

Success. The configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

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.

POSTManaged 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 an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

Validated. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid