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.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/autoupdate SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/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

The request doesn't provide any configurable parameters.

Response

Response codes

Code	Description
200	Success

Response body

Response parameters JSON model

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.

Element	Type	Description
metadata	ConfigurationMetadata
setting	string	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
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`.
updateWindows	UpdateWindowsConfig

The UpdateWindowsConfig object

Basic information about all configured maintenance windows

Element	Type	Description
windows	UpdateWindow[]	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

Element	Type	Description
name	string	The name of maintenance window
id	string	Identifier of maintenance window

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.

    
{
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "currentConfigurationVersions": [
      "string"
    ],
    "clusterVersion": "1.192.1"
  },
  "setting": "DISABLED",
  "version": "1.181.0",
  "updateWindows": {
    "windows": [
      {
        "name": "Daily maintenance window",
        "id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h"
      }
    ]
  }
}