OneAgent environment-wide configuration API - PUT auto-update configuration
Updates 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 consumes an application/json
payload.
PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/autoupdate |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | Environment | The JSON body of the request. Contains OneAgent auto-update parameters. | body | optional |
Request 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 | Required |
---|---|---|---|
metadata | Configuration | Metadata useful for debugging | optional |
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
| required |
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 | optional |
updateWindows | Update | Basic information about all configured maintenance windows | optional |
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 | optional |
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
clusterVersion | string | Dynatrace version. | optional |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
The UpdateWindowsConfig
object
Basic information about all configured maintenance windows
Element | Type | Description | Required |
---|---|---|---|
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. | required |
The UpdateWindow
object
Basic information about one maintenance window
Element | Type | Description | Required |
---|---|---|---|
id | string | Identifier of maintenance window | required |
name | string | 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.
{"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.181.0"}
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Success. The configuration has been updated. Response doesn't have a body. |
400 | Error | 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.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/autoupdate/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/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
Code | Type | Description |
---|---|---|
204 | - | Success. The submitted configuration is valid. Response doesn't have a body. |
400 | Error | Failed. The input is invalid. |