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
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}

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 format

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 MonitoringConfig
autoUpdateConfig HostAutoUpdateConfig
techMonitoringConfigList TechMonitoringList

The TechMonitoringList object

A list of technology monitoring configurations.

Element Type Description
metadata ConfigurationMetadata
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.

The type element can hold these values.
monitoringEnabled boolean

The monitoring of the technology is enabled (true) or disabled (false).

scope string

The validity of the configuration:

  • HOST: The setting is valid for OneAgent on host only. Other OneAgents, connected to the same Dynatrace server may have different setting.
  • ENVIRONMENT: The setting is valid for all OneAgents, connected to the Dynatrace server.
The scope element can hold these values.

The HostAutoUpdateConfig object

Configuration of OneAgent auto-update.

Element Type Description
metadata ConfigurationMetadata
id string

The Dynatrace entity ID of the host where OneAgent is deployed.

setting string

The state of the auto-update on the host: enabled, disabled, or inherited.

If set to INHERITED the setting is inherited from the parent entity:

  • If the host is a member of a host group, the setting is inherited from the host group.
  • If the host doesn't belong to a host group, the setting is inherited from the environment-wide configuration.
The setting element can hold these values.
version string

The version of the OneAgent to which it must be updated.

Specify the version in the <major>.<minor>.<revision>.<timestamp> format (for example 1.191.0.20200326-161115). You can fetch the list of available versions with the GET available versions call.

Only applicable when the effectiveSetting value is DISABLED.

If the setting parameter is set to INHERITED but the version is still set, it will result in a one-time update: OneAgent will be updated to the specified version and the version value will be set to null. For further updates the parent setting will be used.

effectiveSetting string

The actual state of the auto-update on the host.

Applicable only if the setting parameter is set to INHERITED. In that case the value is taken from the parent setting.

The effectiveSetting element can hold these values.
effectiveVersion string

The actual version to which the OneAgent must be updated.

Applicable only if the setting parameter is set to INHERITED and the version parameter is set to null. In that case the value is taken from the parent setting.

The MonitoringConfig object

Monitoring configuration of OneAgent.

Element Type Description
metadata ConfigurationMetadata
id string

The Dynatrace entity ID of the host where OneAgent is deployed.

monitoringEnabled boolean

The monitoring is enabled (true) or disabled (false).

monitoringMode string

The monitoring mode for the host: full stack or infrastructure only.

The monitoringMode element can hold these values.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

clusterVersion string

Dynatrace server version.

configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

Possible values

Possible values for the scope element in the Technology object:

  • ENVIRONMENT
  • HOST

Possible values for the type element in the Technology object:

  • APACHE
  • CIM_V2
  • DOCKER
  • DOCKER_WIN
  • DOT_NET
  • DOT_NET_CORE
  • EXTENSIONS
  • EXTENSIONS_DS_GENERIC
  • EXTENSIONS_STATSD
  • GARDEN
  • GO
  • GO_STATIC
  • IBM_INTEGRATION_BUS
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • NETWORK
  • NGINX
  • NODE_JS
  • OPENTRACING
  • PHP
  • PHP_74
  • PHP_CGI
  • PHP_CLI
  • PHP_NG
  • PHP_WIN
  • PROCESS
  • RUBY
  • SDK
  • VARNISH
  • Z_OS

Possible values for the effectiveSetting element in the HostAutoUpdateConfig object:

  • ENABLED
  • DISABLED

Possible values for the setting element in the HostAutoUpdateConfig object:

  • DISABLED
  • ENABLED
  • INHERITED

Possible values for the monitoringMode element in the MonitoringConfig object:

  • CLOUD_INFRASTRUCTURE
  • FULL_STACK