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.

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}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}

Authentication

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.

Parameters

Parameter Type Description In Required
id string

The Dynatrace entity ID of the required host.

 path required

Response

Response codes

Code Description
200

Success

Response body

The HostConfig object

OneAgent configuration on a host.

Element Type Description
id string

The Dynatrace entity ID of the host where OneAgent is deployed.
monitoringConfig MonitoringConfig
autoUpdateConfig HostAutoUpdateConfig
techMonitoringConfigList TechMonitoringList

The TechMonitoringList object

A list of technology monitoring configurations.

Element Type Description
metadata ConfigurationMetadata
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.
  • ENVIRONMENT: 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
id string

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

The auto-update state of OneAgents on the host:

  • ENABLED: OneAgent automatically updates to the most recent version.
  • DISABLED: OneAgent updates to the version specified in the version field.
  • INHERITED: The setting from the host group (if the host is a member of a host group) or the environment-wide configuration (if the host doesn't belong to a host group) is used.
version string

The version to which the OneAgent must be updated.

Specify the version in the <major>.<minor>.<revision>.<timestamp> format (for example 1.191.0.20200326-161115). You can fetch the list of available versions with the GET available versions call.

If no suitable installer is found for the provided version or the value is set to null, OneAgent won't be updated.

Only applicable when the effectiveSetting value is DISABLED.

If the setting parameter is set to INHERITED but the version is still set, it will result in a one-time update: OneAgent will be updated to the specified version and the version value will be set to null. For further updates the parent setting will be used.
updateWindows UpdateWindowsConfig
effectiveSetting string

The actual state of the auto-update on the host.

Applicable only if the setting parameter is set to INHERITED. In that case the value is taken from the host group or the environment-wide configuration.
effectiveVersion string

The actual version to which the OneAgent must be updated.

Applicable only if the setting parameter is set to INHERITED and the version parameter is set to null. In that case the value is taken from the host group or the environment-wide configuration.

The UpdateWindowsConfig object

Basic information about all configured maintenance windows

Element Type Description
windows UpdateWindow[]

List of maintenance windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience.

The UpdateWindow object

Basic information about one maintenance window

Element Type Description
name string

The name of maintenance window
id string

Identifier of maintenance window

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 version.
currentConfigurationVersions string[]

A sorted list of version numbers of the configuration.
configurationVersions integer[]

A sorted list of the version numbers of the configuration.