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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id} |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/hosts/{id} |
To execute this request, you need an access token with ReadConfig
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string | The Dynatrace entity ID of the required host. | path | required |
Code | Type | Description |
---|---|---|
200 | Host | Success |
HostConfig
objectOneAgent configuration on a host.
Element | Type | Description |
---|---|---|
autoUpdateConfig | Host | Configuration of OneAgent auto-update. |
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
monitoringConfig | Monitoring | Monitoring configuration of OneAgent. |
techMonitoringConfigList | Tech | A list of technology monitoring configurations. |
HostAutoUpdateConfig
objectConfiguration of OneAgent auto-update.
Element | Type | Description |
---|---|---|
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 |
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
metadata | Configuration | Metadata useful for debugging |
setting | string | The auto-update state of OneAgents on the host:
|
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 |
updateWindows | Update | Basic information about all configured update windows |
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 |
ConfigurationMetadata
objectMetadata useful for debugging
Element | Type | Description |
---|---|---|
clusterVersion | string | Dynatrace version. |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
UpdateWindowsConfig
objectBasic information about all configured update windows
Element | Type | Description |
---|---|---|
windows | Update | List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience. |
UpdateWindow
objectBasic information about one maintenance window
Element | Type | Description |
---|---|---|
id | string | Identifier of maintenance window |
name | string | The name of maintenance window |
MonitoringConfig
objectMonitoring configuration of OneAgent.
Element | Type | Description |
---|---|---|
autoInjectionEnabled | boolean | Code modules will be injected automatically into monitored applications if this setting is enabled. This setting won't apply if auto-injection is disabled via oneagentctl (see https://dt-url.net/oneagentctl). |
id | string | The Dynatrace entity ID of the host where OneAgent is deployed. |
metadata | Configuration | Metadata useful for debugging |
monitoringEnabled | boolean | The monitoring is enabled ( |
monitoringMode | string | The monitoring mode for the host: full stack or infrastructure only.
|
TechMonitoringList
objectA list of technology monitoring configurations.
Element | Type | Description |
---|---|---|
metadata | Configuration | Metadata useful for debugging |
technologies | Technology[] | A list of technology monitoring configurations. |
Technology
objectConfiguration of technology monitoring.
Element | Type | Description |
---|---|---|
monitoringEnabled | boolean | The monitoring of the technology is enabled ( |
scope | string | The validity of the configuration:
|
type | string | The type of the technology.
|
{"autoUpdateConfig": {"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"},"id": "HOST-0123456789ABCDE","monitoringConfig": {"autoInjectionEnabled": true,"id": "HOST-0123456789ABCDE","metadata": {},"monitoringEnabled": true,"monitoringMode": "FULL_STACK"},"techMonitoringConfigList": {"metadata": {},"technologies": [{"monitoringEnabled": true,"scope": "ENVIRONMENT","type": "JAVA"}]}}