OneAgent monitoring configuration API - GET configuration

This API is deprecated. Use the Settings API with the Monitoring (builtin:host.monitoring) schema instead.

Gets the monitoring configuration of OneAgent on the specified host.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring
Environment ActiveGatehttps://{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 ReadConfig 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

Response

Response codes

Code
Type
Description
200

Success

Response body objects

The MonitoringConfig object

Monitoring configuration of OneAgent.

Element
Type
Description
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).

id
string

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

metadata

Metadata useful for debugging

monitoringEnabled
boolean

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

monitoringMode
string

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

  • CLOUD_INFRASTRUCTURE
  • DISCOVERY
  • FULL_STACK

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
clusterVersion
string

Dynatrace version.

configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

Response body JSON model

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