• Home
  • Dynatrace API
  • Configuration
  • OneAgent configuration
  • In a host group
  • GET auto-update configuration

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/hostgroups/{id}/autoupdate
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/hostgroups/{id}/autoupdate
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
idstring

The Dynatrace entity ID of the required host group.

pathrequired

Response

Response codes

CodeTypeDescription
200HostGroupAutoUpdateConfig

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.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

idstring

The Dynatrace entity ID of the host group.

settingstring

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.

The element can hold these values
  • DISABLED
  • ENABLED
  • INHERITED
versionstring

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.

updateWindowsUpdateWindowsConfig

Basic information about all configured maintenance windows

effectiveSettingstring

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.

The element can hold these values
  • ENABLED
  • DISABLED
effectiveVersionstring

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

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

The UpdateWindowsConfig object

Basic information about all configured maintenance windows

ElementTypeDescription
windowsUpdateWindow[]

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

ElementTypeDescription
namestring

The name of maintenance window

idstring

Identifier of maintenance window

Response body JSON model

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