OneAgent auto-update API - GET configuration
Gets the configuration of OneAgent auto-update on the specified host.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/autoupdate |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/{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
The Dynatrace entity ID of the required host.
Response
Response codes
Response body objects
The HostAutoUpdateConfig
object
Configuration of OneAgent auto-update.
The actual state of the auto-update on the host.
Applicable only if the setting parameter is set to INHERITED
. In that case the value is taken from the host group or the environment-wide configuration.
ENABLED
DISABLED
The actual version to which the OneAgent must be updated.
Applicable only if the setting parameter is set to INHERITED
and the version parameter is set to null
. In that case the value is taken from the host group or the environment-wide configuration.
The Dynatrace entity ID of the host where OneAgent is deployed.
The auto-update state of OneAgents on the host:
ENABLED
: OneAgent automatically updates to the most recent version.DISABLED
: OneAgent updates to the version specified in the version field.INHERITED
: The setting from the host group (if the host is a member of a host group) or the environment-wide configuration (if the host doesn't belong to a host group) is used.
DISABLED
ENABLED
INHERITED
Version to update a OneAgent to when automatic updates are enabled.
Supports relative versions latest
, previous
and older
as well as specific version in <major>.<minor>
format (for example 1.261
) or <major>.<minor>.<revision>.<timestamp>
format (for example 1.261.178.20230313-090930
).
Only applicable when the setting parameter is set to ENABLED
.
The version to which the OneAgent must be updated.
Specify the version in the <major>.<minor>.<revision>.<timestamp>
format (for example 1.191.0.20200326-161115
). 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 effectiveSetting value is DISABLED
.
If the setting parameter is set to INHERITED
but the version is still set, it will result in a one-time update: OneAgent will be updated to the specified version and the version value will be set to null
. For further updates the parent setting will be used.
The ConfigurationMetadata
object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
The UpdateWindowsConfig
object
Basic information about all configured maintenance windows
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
Identifier of maintenance window
The name of maintenance window
Response body JSON model
{"effectiveSetting": "DISABLED","effectiveVersion": "1.191.0.20200326-161115","id": "HOST-0123456789ABCDE","metadata": {"clusterVersion": "1.192.1","configurationVersions": [4,2],"currentConfigurationVersions": ["1.0.4","1.23"]},"setting": "DISABLED","targetVersion": "latest","updateWindows": {"windows": [{"id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h","name": "Daily maintenance window"}]},"version": "1.191.0.20200326-161115"}