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 |
|
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
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 |
Configuration |
|
setting | string | The auto-update state of OneAgents connecting to the environment:
OneAgents that connect to the environment use this configuration only when their setting parameter is set to |
version | string | The version to which the OneAgent must be updated. Specify the version in the Only applicable when the setting parameter is set to |
updateWindows |
Update |
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"
}
]
}
}