OneAgent in a host group API - PUT auto-update configuration
Updates the configuration of OneAgent auto-update in the specified host group.
OneAgents installed on hosts of the host group 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 |
---|---|---|---|---|
id | string |
The Dynatrace entity ID of the required host group. |
path | required |
body | HostGroupAutoUpdateConfig |
The JSON body of the request. Contains OneAgent auto-update parameters. |
body | optional |
Body format
The HostGroupAutoUpdateConfig object
Configuration of OneAgent auto-update in a host group.
Applies to all OneAgents installed on hosts of the host group if their setting parameter is set to INHERITED
. Otherwise, the host level setting applies.
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata | optional | |
id | string |
The Dynatrace entity ID of the host group. |
optional |
setting | string |
The auto-update state of OneAgents in a host group:
OneAgents installed on hosts of the host group 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 |
effectiveSetting | string |
The actual state of the auto-update on the hosts in a host group. 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 |
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 |
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"
},
"id": "HOST_GROUP-0123456789ABCDE",
"setting": "DISABLED",
"version": "1.181.0",
"effectiveSetting": "DISABLED",
"effectiveVersion": "1.181.0"
}
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.