OneAgent in a host group API - GET auto-update configuration

Gets the configuration of OneAgent auto-update in 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.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/hostgroups/{id}/autoupdate
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hostgroups/{id}/autoupdate

Authentication

To execute this request, you need an access token with ReadConfig scope.

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
Type
Description
200

Success

Response body objects

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

  • ENABLED
  • DISABLED
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.

id
string

The Dynatrace entity ID of the host group.

metadata

Metadata useful for debugging

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.

  • DISABLED
  • ENABLED
  • INHERITED
targetVersion
string

Version to update a OneAgent to when automatic updates are enabled.

Supports relative versions latest, previous and older as well as specific version in <major>.<minor> format (for example 1.261) or <major>.<minor>.<revision>.<timestamp> format (for example 1.261.178.20230313-090930).

Only applicable when the setting parameter is set to ENABLED.

updateWindows

Basic information about all configured update windows

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) or <major>.<minor> format (for example 1.181). 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.

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
clusterVersion
string

Dynatrace version.

configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

The UpdateWindowsConfig object

Basic information about all configured update windows

Element
Type
Description
windows

List of update 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
id
string

Identifier of maintenance window

name
string

The name of maintenance window

Response body JSON model

{
  "effectiveSetting": "DISABLED",
  "effectiveVersion": "1.181.0",
  "id": "HOST_GROUP-0123456789ABCDE",
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  },
  "setting": "DISABLED",
  "targetVersion": "latest",
  "updateWindows": {
    "windows": [
      {
        "id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
        "name": "Daily maintenance window"
      }
    ]
  },
  "version": "1.181.0"
}