OneAgent auto-update API - PUT configuration

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

The request consumes an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/autoupdate
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/autoupdate

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The Dynatrace entity ID of the required host.

path required
body HostAutoUpdateConfig

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

body optional

Body format

The HostAutoUpdateConfig object

Configuration of OneAgent auto-update.

Element Type Description Required
metadata ConfigurationMetadata optional
id string

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

optional
setting string

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.
required
version string

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
effectiveSetting string

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.

optional
effectiveVersion string

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

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.

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.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/autoupdate/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/autoupdate/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.