OneAgent on a host API

The OneAgent on a host API enables you to check the configuration of OneAgent instances on your hosts.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/oneagents
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/oneagents

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
startTimestamp integer

The start timestamp of the requested timeframe, in milliseconds (UTC).

If not set, then 72 hours behind from now is used.

query optional
endTimestamp integer

The end timestamp of the requested timeframe, in milliseconds (UTC).

If not set, then the current timestamp is used.

The timeframe must not exceed 3 months (92 days).

query optional
relativeTime string

The relative timeframe, back from now.

If you need to specify relative timeframe that is not presented in the list of possible values, specify the startTimestamp (up to 92 days back from now) and leave endTimestamp and relativeTime empty.

The relativeTime element can hold these values.
query optional
tag array

Filters the resulting set of hosts by the specified tag. You can specify several tags in the following format: tag=tag1&tag=tag2. The host has to match all the specified tags.

In case of key-value tags, such as imported AWS or CloudFoundry tags, use the following format: tag=[context]key:value. For custom key-value tags, omit the context: tag=key:value.

query optional
entity array

Filters result to the specified hosts only.

To specify several hosts use the following format: entity=ID1&entity=ID2.

query optional
managementZoneId integer

Only return hosts that are part of the specified management zone.

Specify the management zone ID here.

query optional
managementZone string

Only return hosts that are part of the specified management zone.

Specify the management zone name here.

If the managementZoneId parameter is set, this parameter is ignored.

query optional
networkZoneId string

Filters the resulting set of hosts by the specified network zone.

Specify the Dynatrace entity ID of the required network zone. You can fetch the list of available network zones with the GET all network zones call.

query optional
hostGroupId string

Filters the resulting set of hosts by the specified host group.

Specify the Dynatrace entity ID of the required host group.

query optional
hostGroupName string

Filters the resulting set of hosts by the specified host group.

Specify the name of the required host group.

query optional
osType string

Filters the resulting set of hosts by the OS type.

The osType element can hold these values.
query optional
availabilityState string

Filters the resulting set of hosts by the availability state of OneAgent.

  • MONITORED: Hosts where OneAgent is enabled and active.
  • UNMONITORED: Hosts where OneAgent is disabled and inactive.
  • CRASHED: Hosts where OneAgent has returned a crash status code.
  • LOST: Hosts where it is impossible to establish connection with OneAgent.
  • PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring.
  • SHUTDOWN: Hosts where OneAgent is shutting down in a controlled process.
  • UNEXPECTED_SHUTDOWN: Hosts where OneAgent is shutting down in an uncontrolled process.
  • UNKNOWN: Hosts where the state of OneAgent is unknown.
The availabilityState element can hold these values.
query optional
monitoringType string

Filters the resulting set of hosts by monitoring mode of OneAgent deployed on the host.

The monitoringType element can hold these values.
query optional
agentVersionIs string

Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host.

Specify the comparison operator here.

The agentVersionIs element can hold these values.
query optional
agentVersionNumber string

Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host.

Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call.

query optional
autoUpdateSetting string

Filters the resulting set of hosts by the actual state of the auto-update setting of deployed OneAgents.

The autoUpdateSetting element can hold these values.
query optional
updateStatus string

Filters the resulting set of hosts by the update status of OneAgent deployed on the host.

The updateStatus element can hold these values.
query optional
faultyVersion boolean

Filters the resulting set of hosts to those that run OneAgent version that is marked as faulty.

query optional
technologyModuleType string

Filters the resulting set of hosts to those that run the specified OneAgent code module.

If several code module filters are set, the code module has to match all the filters.

The technologyModuleType element can hold these values.
query optional
technologyModuleVersionIs string

Filters the resulting set of hosts to those that have a certain code module version deployed on the host.

Specify the comparison operator here.

If several code module filters are set, the code module has to match all the filters.

The technologyModuleVersionIs element can hold these values.
query optional
technologyModuleVersionNumber string

Filters the resulting set of hosts to those that have a certain code module version deployed on the host.

Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call.

If several code module filters are set, the code module has to match all the filters.

query optional
technologyModuleFaultyVersion boolean

Filters the resulting set of hosts to those that run the code module version that is marked as faulty.

If several code module filters are set, the code module has to match all the filters.

query optional
pluginName string

Filters the resulting set of hosts to those that run the plugin with the specified name.

The CONTAINS operator is applied to the specified value.

If several plugin filters are set, the plugin has to match all the filters.

query optional
pluginVersionIs string

Filters the resulting set of hosts to those that have a certain plugin version deployed on the host.

Specify the comparison operator here.

If several plugin filters are set, the plugin has to match all the filters.

The pluginVersionIs element can hold these values.
query optional
pluginVersionNumber string

Filters the resulting set of hosts to those that have a certain plugin version deployed on the host.

Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call.

<minor> and <revision> parts of the version number are optional.

If several plugin filters are set, the plugin has to match all the filters.

query optional
pluginState string

Filters the resulting set of hosts to those that run the plugin with the specified state.

The pluginState element can hold these values.
query optional
nextPageKey string

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify this cursor.

You must keep all other query parameters as they were in the first request to obtain subsequent pages.

query optional

Possible values

Possible values for the pluginState element:

  • DISABLED
  • ERROR_AUTH
  • ERROR_COMMUNICATION_FAILURE
  • ERROR_CONFIG
  • ERROR_TIMEOUT
  • ERROR_UNKNOWN
  • INCOMPATIBLE
  • LIMIT_REACHED
  • NOTHING_TO_REPORT
  • OK
  • STATE_TYPE_UNKNOWN
  • UNINITIALIZED
  • UNSUPPORTED
  • WAITING_FOR_STATE

Possible values for the pluginVersionIs element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Possible values for the technologyModuleVersionIs element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Possible values for the technologyModuleType element:

  • APACHE
  • DOT_NET
  • DUMPPROC
  • GO
  • IBM_INTEGRATION_BUS
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • NETWORK
  • NGINX
  • NODE_JS
  • OPENTRACING
  • PHP
  • PROCESS
  • PYTHON
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • Z_OS

Possible values for the updateStatus element:

  • INCOMPATIBLE
  • OUTDATED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM

Possible values for the autoUpdateSetting element:

  • ENABLED
  • DISABLED

Possible values for the agentVersionIs element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Possible values for the monitoringType element:

  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
  • STANDALONE

Possible values for the availabilityState element:

  • CRASHED
  • LOST
  • MONITORED
  • PRE_MONITORED
  • SHUTDOWN
  • UNEXPECTED_SHUTDOWN
  • UNKNOWN
  • UNMONITORED

Possible values for the osType element:

  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS

Possible values for the relativeTime element:

  • 10mins
  • 15mins
  • 2hours
  • 30mins
  • 3days
  • 5mins
  • 6hours
  • day
  • hour
  • min
  • month
  • week

Response format

The HostsListPage object

A list of hosts with OneAgent deployment information for each host.

Element Type Description
percentageOfEnvironmentSearched number

The progress of the environment search, in percent.

nextPageKey string

The cursor for the next page of results.

Has the value of null on the last page.

There might be another page of results even if the current page is empty.

hosts HostAgentInfo[]

A list of hosts with OneAgent deployment information for each host.

The HostAgentInfo object

OneAgent deployment on a host.

Element Type Description
hostInfo Host
faultyVersion boolean

OneAgent version is faulty (true) or not (false).

active boolean

OneAgent is active (true) or inactive (false).

configuredMonitoringMode string

Configured monitoring mode of OneAgent.

The configuredMonitoringMode element can hold these values.
monitoringType string

The monitoring mode of OneAgent.

The monitoringType element can hold these values.
autoUpdateSetting string

The effective auto-update setting of OneAgent. For host with inherited configuration it is calculated from its parent's configuration

The autoUpdateSetting element can hold these values.
updateStatus string

The current update status of OneAgent.

The updateStatus element can hold these values.
availableVersions string[]

A list of versions OneAgent can be updated to.

configuredMonitoringEnabled boolean

Monitoring is enabled (true) or disabled (false) in the OneAgent configuration.

availabilityState string

The availability state of OneAgent.

The availabilityState element can hold these values.
currentActiveGateId integer

The ID of an ActiveGate to which OneAgent is connected.

currentNetworkZoneId string

The ID of the network zone that OneAgent is using.

modules ModuleInfo[]

A list of code modules deployed on the host.

plugins PluginInfo[]

A list of plugins deployed on the host.

The PluginInfo object

OneAgent plugin.

Element Type Description
pluginName string

The name of the plugin.

instances PluginInstance[]

A list of instances of the plugin.

The PluginInstance object

An instance of the OneAgent plugin.

Element Type Description
pluginVersion string

The version of the plugin.

state string

The state of the plugin instance.

The ModuleInfo object

OneAgent code module.

Element Type Description
moduleType string

The type of the code module.

The moduleType element can hold these values.
instances ModuleInstance[]

A list of instances of the code module.

The ModuleInstance object

An instance of the OneAgent code module.

Element Type Description
instanceName string

The name of the instance.

moduleVersion string

The version of the code module.

faultyVersion boolean

The code module version is faulty (true) or not (false).

active boolean

The code module instance is active (true) or inactive (false).

The Host object

Information about the host.

Element Type Description
entityId string

The Dynatrace entity ID of the required entity.

displayName string

The name of the Dynatrace entity as displayed in the UI.

customizedName string

The customized name of the entity

discoveredName string

The discovered name of the entity

firstSeenTimestamp integer

The timestamp of when the entity was first detected, in UTC milliseconds

lastSeenTimestamp integer

The timestamp of when the entity was last detected, in UTC milliseconds

tags TagInfo[]

The list of entity tags.

toRelationships object
openstackProjectName string
logicalCpuCores integer
kubernetesLabels object

The kubernetes labels defined on the entity.

paasType string The paasType element can hold these values.
azureComputeModeName string The azureComputeModeName element can hold these values.
paasMemoryLimit integer
osVersion string
zosTotalPhysicalMemory integer

Memory assigned to the host (Terabyte).

openstackSecurityGroups string[]
consumedHostUnits string
zosTotalGeneralPurposeProcessors integer

Number of assigned processors for this LPAR.

azureHostNames string[]
gceInstanceId string

The Google Compute Engine instance ID.

softwareTechnologies TechnologyInfo[]
zosTotalZiipProcessors integer

Number of assigned support processors for this LPAR.

gceProject string

The Google Compute Engine project.

osType string The osType element can hold these values.
boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

ipAddresses string[]
autoScalingGroup string
boshName string

The Cloud Foundry BOSH name.

gceProjectId string

The Google Compute Engine numeric project ID.

boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

cloudType string The cloudType element can hold these values.
azureSiteNames string[]
boshInstanceName string

The Cloud Foundry BOSH instance name.

boshInstanceId string

The Cloud Foundry BOSH instance ID.

zosCPUModelNumber string

The CPU model number.

beanstalkEnvironmentName string
gceMachineType string

The Google Compute Engine machine type.

gcePublicIpAddresses string[]

The public IP addresses of the Google Compute Engine.

zosCPUSerialNumber string

The CPU serial number.

cpuCores integer
isMonitoringCandidate boolean
awsNameTag string

The name inherited from AWS.

networkZoneId string

The ID of network zone the entity is in.

awsInstanceId string
publicIp string
hypervisorType string The hypervisorType element can hold these values.
azureVmName string
publicHostName string
logicalCpus integer

The AIX instance logical CPU count.

paasAgentVersions AgentVersion[]

The versions of the PaaS agents currently running on the entity.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

openStackInstaceType string
agentVersion AgentVersion
openstackVmName string
zosVirtualization string

Type of virtualization on the mainframe.

boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

vmwareName string
hostGroup HostGroup
amiId string
scaleSetName string
openstackAvZone string
userLevel string The userLevel element can hold these values.
awsInstanceType string
openstackComputeNodeName string
monitoringMode string The monitoringMode element can hold these values.
kubernetesNode string

The kubernetes node the entity is in.

gcpZone string

The Google Cloud Platform Zone.

cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

virtualCpus integer

The AIX instance virtual CPU count.

awsSecurityGroup string[]
bitness string The bitness element can hold these values.
gceInstanceName string

The Google Compute Engine instance name.

esxiHostName string
oneAgentCustomHostName string

The custom name defined in OneAgent config.

localHostName string
azureSku string The azureSku element can hold these values.
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

localIp string
osArchitecture string The osArchitecture element can hold these values.
kubernetesCluster string

The kubernetes cluster the entity is in.

fromRelationships object

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

The HostGroup object

Element Type Description
meId string

The Dynatrace entity ID of the host group.

name string

The name of the Dynatrace entity, displayed in the UI.

The AgentVersion object

Defines the version of the agent currently running on the entity.

Element Type Description
major integer

The major version number.

minor integer

The minor version number.

revision integer

The revision number.

timestamp string

A timestamp string: format "yyyymmdd-hhmmss

sourceRevision string

A string representation of the SVN revision number.

The TechnologyInfo object

Element Type Description
type string
edition string
version string

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The context element can hold these values.
key string

The key of the tag.

Custom tags have the tag value here.

value string

The value of the tag.

Not applicable to custom tags.

Possible values

Possible values for the moduleType element in the ModuleInfo object:

  • APACHE
  • DOT_NET
  • DUMPPROC
  • GO
  • IBM_INTEGRATION_BUS
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • NETWORK
  • NGINX
  • NODE_JS
  • OPENTRACING
  • PHP
  • PROCESS
  • PYTHON
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • Z_OS

Possible values for the availabilityState element in the HostAgentInfo object:

  • CRASHED
  • LOST
  • MONITORED
  • PRE_MONITORED
  • SHUTDOWN
  • UNEXPECTED_SHUTDOWN
  • UNKNOWN
  • UNMONITORED

Possible values for the updateStatus element in the HostAgentInfo object:

  • INCOMPATIBLE
  • OUTDATED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM

Possible values for the autoUpdateSetting element in the HostAgentInfo object:

  • ENABLED
  • DISABLED

Possible values for the monitoringType element in the HostAgentInfo object:

  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
  • STANDALONE

Possible values for the configuredMonitoringMode element in the HostAgentInfo object:

  • CLOUD_INFRASTRUCTURE
  • FULL_STACK

Possible values for the osArchitecture element in the Host object:

  • ARM
  • IA64
  • PARISC
  • PPC
  • PPCLE
  • S390
  • SPARC
  • X86
  • ZOS

Possible values for the azureSku element in the Host object:

  • BASIC
  • DYNAMIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD

Possible values for the bitness element in the Host object:

  • 32bit
  • 64bit

Possible values for the monitoringMode element in the Host object:

  • FULL_STACK
  • INFRASTRUCTURE
  • OFF

Possible values for the userLevel element in the Host object:

  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER

Possible values for the hypervisorType element in the Host object:

  • AHV
  • HYPERV
  • KVM
  • LPAR
  • QEMU
  • VIRTUALBOX
  • VMWARE
  • WPAR
  • XEN

Possible values for the cloudType element in the Host object:

  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE

Possible values for the osType element in the Host object:

  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS

Possible values for the azureComputeModeName element in the Host object:

  • DEDICATED
  • SHARED

Possible values for the paasType element in the Host object:

  • AWS_ECS_EC2
  • AWS_ECS_FARGATE
  • AWS_LAMBDA
  • AZURE_FUNCTIONS
  • AZURE_WEBSITES
  • CLOUD_FOUNDRY
  • GOOGLE_APP_ENGINE
  • HEROKU
  • KUBERNETES
  • OPENSHIFT

Possible values for the context element in the TagInfo object:

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES