OneAgent on a host API - GET auto-update configuration
Gets the configuration of OneAgent auto-update on 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 produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig
) 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 |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
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 |
---|---|---|
metadata | ConfigurationMetadata | |
id | string | The Dynatrace entity ID of the host group. |
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 |
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 |
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 |
effectiveVersion | string | The actual version to which the OneAgent must be updated. Applicable only if the setting parameter is set to |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
configurationVersions | integer[] | A Sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A Sorted list of string version numbers of the configuration. |
clusterVersion | string | Dynatrace server version. |
{
"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"
}