OneAgent auto-update API - GET configuration

Gets the configuration of OneAgent auto-update 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}/autoupdate
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/autoupdate

Parameters

Parameter Type Description In Required
id string

The Dynatrace entity ID of the required host.

path required

Response format

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 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 environment-wide configuration.
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.191.0.20200326-161115). You can fetch the list of available versions with the GET available versions call.

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.

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 parent setting.

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 parent setting.

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.