OneAgent auto-update API - PUT configuration

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

The request consumes an application/json payload.

This request is currently in preview and is subject to change. Changes may not be compatible with your current configuration.

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

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

The HostAutoUpdateConfig object

Configuration of OneAgent auto-update.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

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

optional
setting string

The state of the auto-update on the host: enabled, disabled, or inherited.

If set to INHERITED the setting is inherited from the parent entity:

  • If the host is a member of a host group, the setting is inherited from the host group.
  • If the host doesn't belong to a host group, the setting is inherited from the Dynatrace server.
The setting element can hold these values.
required
version string

The version of the OneAgent to which it must be updated.

Specify the version in the <major>.<minor>.<revision>.<timestamp> format, for example 1.182.0.20191104-192915. You can fetch the list of available versions with the GET available versions call.

Only applicable when the setting parameter is set to DISABLED.

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

Dynatrace server version.

optional

Possible values

Possible values for the setting element in the HostAutoUpdateConfig object:

  • DISABLED
  • ENABLED
  • INHERITED

Response format

A successful request doesn't return any content.

Response codes

Code Description
204 Success. The configuration has been updated. Response doesn't have a body.
400 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.

This request is currently in preview and is subject to change. Changes may not be compatible with your current configuration.

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

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response doesn't have a body.
400 Failed. The input is invalid.