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 |
|
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 |
---|---|---|---|---|
body |
Environment |
The JSON body of the request. Contains OneAgent auto-update parameters. |
body | optional |
Body format
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 |
---|---|---|---|
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 |
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 |
updateWindows |
Update |
optional |
The UpdateWindowsConfig object
Basic information about all configured maintenance windows
Element | Type | Description | Required |
---|---|---|---|
windows | UpdateWindow[] |
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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"setting": "DISABLED",
"version": "1.181.0",
"updateWindows": {
"windows": [
{
"name": "Daily maintenance window",
"id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h"
}
]
}
}
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 |
|
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 | Success. 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.