OneAgent on a host API - OneAgent configuration

Gets OneAgent configuration on the specified host. You can later change the auto-update and monitoring configuration with one of the following requests:

The request produces an application/json payload.

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}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}

Parameters

Parameter Type Description In Required
id string

The Dynatrace entity ID of the required host.

path required

Response format

The HostConfig object

OneAgent configuration on a host.

Element Type Description
monitoringConfig MonitoringConfig

Monitoring configuration of OneAgent.

autoUpdateConfig HostAutoUpdateConfig

Configuration of OneAgent auto-update.

techMonitoringConfigList TechMonitoringList

A list of technology monitoring configurations.

The TechMonitoringList object

A list of technology monitoring configurations.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

technologies Technology[]

A list of technology monitoring configurations.

The Technology object

Configuration of technology monitoring.

Element Type Description
type string

The type of the technology.

monitoringEnabled boolean

The monitoring of the technology is enabled (true) or disabled (false).

scope string

The validity of the configuration:

  • HOST: The setting is valid for OneAgent on host only. Other OneAgents, connected to the same Dynatrace server may have different setting.
  • TENANT: The setting is valid for all OneAgents, connected to the Dynatrace server.

The HostAutoUpdateConfig object

Configuration of OneAgent auto-update.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

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

setting string

The state of the auto-update on the host: enabled, disabled, or inherited.

If set to INHERITED the setting is inherited from the parent entity:

  • If the host is a member of a host group, the setting is inherited from the host group.
  • If the host doesn't belong to a host group, the setting is inherited from the Dynatrace server.
version string

The version of the OneAgent to which it must be updated.

Specify the version in the <major>.<minor>.<revision>.<timestamp> format, for example 1.182.0.20191104-192915. You can fetch the list of available versions with the GET available versions call.

Only applicable when the setting parameter is set to DISABLED.

The MonitoringConfig object

Monitoring configuration of OneAgent.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

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 cloud infrastructure.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.