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 | ManagedDynatrace for Government | 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 | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/hosts/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
The request doesn't provide any configurable parameters.
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Environment | 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.
Element | Type | Description |
---|---|---|
metadata | Configuration | Metadata useful for debugging |
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 | Basic information about all configured maintenance windows |
targetVersion | string | Version to update a OneAgent to when automatic updates are enabled. Supports relative versions Only applicable when the setting parameter is set to |
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 version numbers of the configuration. |
clusterVersion | string | Dynatrace version. |
The UpdateWindowsConfig
object
Basic information about all configured maintenance windows
Element | Type | Description |
---|---|---|
windows | Update | 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 |
---|---|---|
id | string | Identifier of maintenance window |
name | string | The name of maintenance window |
Response body JSON model
{
"metadata": {
"configurationVersions": [
4,
2
],
"currentConfigurationVersions": [
"1.0.4",
"1.23"
],
"clusterVersion": "1.192.1"
},
"setting": "DISABLED",
"version": "1.181.0",
"updateWindows": {
"windows": [
{
"id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
"name": "Daily maintenance window"
}
]
},
"targetVersion": "latest"
}