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 | 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 WriteConfig
scope.
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 | Host | The JSON body of the request. Contains OneAgent auto-update parameters. | body | optional |
Request body objects
The HostAutoUpdateConfig
object
Configuration of OneAgent auto-update.
Element | Type | Description | Required |
---|---|---|---|
effectiveSetting | string | The actual state of the auto-update on the host. Applicable only if the setting parameter is set to
| optional |
effectiveVersion | string | The actual version to which the OneAgent must be updated. Applicable only if the setting parameter is set to | optional |
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. | optional |
metadata | Configuration | Metadata useful for debugging | optional |
setting | string | The auto-update state of OneAgents on the host:
| 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 If no suitable installer is found for the provided version or the value is set to Only applicable when the effectiveSetting value is If 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.
{"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
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/{id}/autoupdate/validator |
Environment ActiveGate | https://{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
Code | Type | Description |
---|---|---|
204 | - | Validated. The submitted configuration is valid. Response doesn't have a body. |
400 | Error | Failed. The input is invalid |