OneAgent monitoring configuration API - GET configuration

  • Reference
  • Deprecated

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

ParameterTypeDescriptionInRequired
idstring

The Dynatrace entity ID of the required host.

pathrequired

Response

Response codes

CodeTypeDescription
200MonitoringConfig

Success

Response body objects

The MonitoringConfig object

Monitoring configuration of OneAgent.

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

idstring

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

metadataConfigurationMetadata

Metadata useful for debugging

monitoringEnabledboolean

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

monitoringModestring

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

  • CLOUD_INFRASTRUCTURE
  • DISCOVERY
  • FULL_STACK

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

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"
}