• Home
  • Dynatrace API
  • Configuration
  • OneAgent configuration
  • Environment-wide configuration
  • GET auto-update configuration

OneAgent environment-wide configuration API - GET auto-update configuration

Gets the environment-wide configuration of OneAgent auto-update.

OneAgents that connect to the environment use this configuration only when their setting is set to INHERITED.

The request produces an application/json payload.

GETManagedhttps://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/autoupdate
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/autoupdate
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/hosts/autoupdate

Authentication

To execute this request, you need an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200EnvironmentAutoUpdateConfig

Success

Response body objects

The EnvironmentAutoUpdateConfig object

Environment-wide configuration of OneAgents auto-updates.

Applies to all OneAgents connecting to the environment if their setting parameter is set to INHERITED. Otherwise, the host group or host level setting applies.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

settingstring

The auto-update state of OneAgents connecting to the environment:

  • ENABLED: OneAgents automatically update to the most recent version.
  • DISABLED: OneAgents update to the version specified in the version field.

OneAgents that connect to the environment use this configuration only when their setting parameter is set to INHERITED.

The element can hold these values
  • ENABLED
  • DISABLED
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

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

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": {
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ]
  },
  "setting": "DISABLED",
  "version": "1.181.0",
  "updateWindows": {
    "windows": [
      {
        "name": "Daily maintenance window",
        "id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h"
      }
    ]
  }
}