OneAgent auto-update API - PUT configuration

Updates the configuration of OneAgent auto-update on the specified host.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/autoupdate
Environment ActiveGatehttps://{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 WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The Dynatrace entity ID of the required host.

pathrequired
bodyHostAutoUpdateConfig

The JSON body of the request. Contains OneAgent auto-update parameters.

bodyoptional

Request body objects

The HostAutoUpdateConfig object

Configuration of OneAgent auto-update.

ElementTypeDescriptionRequired
effectiveSettingstring

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
optional
effectiveVersionstring

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.

optional
idstring

The Dynatrace entity ID of the host where OneAgent is deployed.

optional
metadataConfigurationMetadata

Metadata useful for debugging

optional
settingstring

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
required
targetVersionstring

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.

optional
updateWindowsUpdateWindowsConfig

Basic information about all configured update windows

optional
versionstring

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.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
clusterVersionstring

Dynatrace version.

optional
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional

The UpdateWindowsConfig object

Basic information about all configured update windows

ElementTypeDescriptionRequired
windowsUpdateWindow[]

List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience.

required

The UpdateWindow object

Basic information about one maintenance window

ElementTypeDescriptionRequired
idstring

Identifier of maintenance window

required
namestring

The name of maintenance window

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "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"
}

Response

Response codes

CodeTypeDescription
204-

Success. The configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

Validated. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid