OneAgent on a host API - GET auto-update configuration

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

OneAgents installed on hosts of the host group use this configuration only when their setting is set to INHERITED.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hostgroups/{id}/autoupdate
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hostgroups/{id}/autoupdate

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

path required

Response

Response codes

Code Description
200

Success

Response body

The HostGroupAutoUpdateConfig object

Configuration of OneAgent auto-update in a host group.

Applies to all OneAgents installed on hosts of the host group if their setting parameter is set to INHERITED. Otherwise, the host level setting applies.

Element Type Description
metadata ConfigurationMetadata
id string

The Dynatrace entity ID of the host group.

setting string

The auto-update state of OneAgents in a host group:

  • ENABLED: OneAgents automatically update to the most recent version.
  • DISABLED: OneAgents update to the version specified in the version field.
  • INHERITED: The setting from the environment-wide configuration is used.

OneAgents installed on hosts of the host group use this configuration only when their setting parameter is set to INHERITED.

version string

The version to which the OneAgent must be updated.

Specify the version in the <major>.<minor>.<revision> format (for example 1.181.0). 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 setting parameter is set to DISABLED.

effectiveSetting string

The actual state of the auto-update on the hosts in a host group.

Applicable only if the setting parameter is set to INHERITED. In that case the value is taken from the environment-wide setting.

effectiveVersion string

The actual version to which the OneAgent must be updated.

Applicable only if the setting parameter is set to INHERITED. In that case the value is taken from the environment-wide setting.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

clusterVersion string

Dynatrace server version.