OneAgent auto-update API - GET configuration

Gets the configuration of OneAgent auto-update on the specified host.

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.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/autoupdate
  • SaaS https://{your-environment-id}{id}/autoupdate


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

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