OneAgent monitoring configuration API - GET configuration

Gets the monitoring configuration of OneAgent on the specified host.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring
  • SaaS https://{your-environment-id}{id}/monitoring


To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
id string

The Dynatrace entity ID of the required host.

path required

Response format

The MonitoringConfig object

Monitoring configuration of OneAgent.

Element Type Description
metadata ConfigurationMetadata
id string

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

monitoringEnabled boolean

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

monitoringMode string

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

The monitoringMode element can hold these values.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

clusterVersion string

Dynatrace server version.

configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

Possible values

Possible values for the monitoringMode element in the MonitoringConfig object: