OneAgent monitoring configuration API - GET configuration

Gets the monitoring configuration of OneAgent on the specified host.

The request produces an application/json payload.

Preview

This request is currently in Preview and is subject to change. Changes may not be compatible with your current configuration.

GET	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

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. To learn how to obtain and use it, see the Authentication page.

Parameters

Parameter	Type	Description	In	Required
id	string	The Dynatrace entity ID of the required host.	path	required

Response format

Response parameters JSON model

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 ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
clusterVersion	string	Dynatrace server version.
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.

    
{
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      "integer"
    ]
  },
  "id": "HOST-0123456789ABCDE",
  "monitoringEnabled": true,
  "monitoringMode": "FULL_STACK"
}