OneAgent on a host API - OneAgent configuration
Gets OneAgent configuration on the specified host. You can later change the auto-update and monitoring configuration with one of the following requests:
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. |
path | required |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The HostConfig object
OneAgent configuration on a host.
Element | Type | Description |
---|---|---|
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
monitoringConfig |
Monitoring |
|
autoUpdateConfig |
Host |
|
techMonitoringConfigList |
Tech |
The TechMonitoringList object
A list of technology monitoring configurations.
Element | Type | Description |
---|---|---|
metadata |
Configuration |
|
technologies | Technology[] | A list of technology monitoring configurations. |
The Technology object
Configuration of technology monitoring.
Element | Type | Description |
---|---|---|
type | string | The type of the technology. |
monitoringEnabled | boolean | The monitoring of the technology is enabled ( |
scope | string | The validity of the configuration:
|
The HostAutoUpdateConfig object
Configuration of OneAgent auto-update.
Element | Type | Description |
---|---|---|
metadata |
Configuration |
|
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
setting | string | The auto-update state of OneAgents on the host:
|
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 |
updateWindows |
Update |
|
effectiveSetting | string | The actual state of the auto-update on the host. 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 UpdateWindowsConfig object
Basic information about all configured maintenance windows
Element | Type | Description |
---|---|---|
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. |
The UpdateWindow object
Basic information about one maintenance window
Element | Type | Description |
---|---|---|
name | string | The name of maintenance window |
id | string | Identifier of maintenance window |
The MonitoringConfig object
Monitoring configuration of OneAgent.
Element | Type | Description |
---|---|---|
metadata |
Configuration |
|
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
monitoringEnabled | boolean | The monitoring is enabled ( |
monitoringMode | string | The monitoring mode for the host: full stack or infrastructure only. |
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. |
{
"id": "HOST-0123456789ABCDE",
"monitoringConfig": {
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"id": "HOST-0123456789ABCDE",
"monitoringEnabled": true,
"monitoringMode": "FULL_STACK"
},
"autoUpdateConfig": {
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"id": "HOST-0123456789ABCDE",
"setting": "DISABLED",
"version": "1.191.0.20200326-161115",
"updateWindows": {
"windows": [
{
"name": "Daily maintenance window",
"id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h"
}
]
},
"effectiveSetting": "DISABLED",
"effectiveVersion": "1.191.0.20200326-161115"
},
"techMonitoringConfigList": {
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"technologies": [
{
"type": "JAVA",
"monitoringEnabled": true,
"scope": "ENVIRONMENT"
}
]
}
}