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
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/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
includeDetails boolean

Includes (true) or excludes (false) details which are queried from related entities.

Excluding details may make queries faster.

If not set, then true is used.

query optional
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 7 months (214 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 214 days back from now) and leave endTimestamp and relativeTime empty.

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.

query optional
cloudType string

Filters the resulting set of hosts by the cloud type.

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.
query optional
detailedAvailabilityState string

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

  • UNKNOWN: Hosts where the state of OneAgent is unknown.
  • PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring.
  • CRASHED_UNKNOWN: Hosts where OneAgent has crashed for unknown reason.
  • CRASHED_FAILURE: Hosts where OneAgent has returned a crash status code.
  • LOST_UNKNOWN: Hosts where it is impossible to establish connection with OneAgent for unknown reason.
  • LOST_CONNECTION: Hosts where OneAgent has been recognized to be inactive.
  • SHUTDOWN_UNKNOWN_UNEXPECTED: Hosts where OneAgent is shutting down in an uncontrolled process.
  • SHUTDOWN_UNKNOWN: Hosts where OneAgent has shutdown for unknown reason.
  • SHUTDOWN_GRACEFUL: Hosts where OneAgent has shutdown because of host shutdown.
  • SHUTDOWN_AGENT_LOST: Hosts where PaaS module has been recognized to be inactive.
  • SHUTDOWN_SPOT_INSTANCE: Hosts where OneAgent shutdown was triggered by the AWS Spot Instance interruption.
  • UNMONITORED_UNKNOWN: Hosts where OneAgent is disabled and inactive for unknown reason.
  • UNMONITORED_TERMINATED: Hosts where OneAgent has terminated.
  • UNMONITORED_DISABLED: Hosts where OneAgent has been disabled in configuration.
  • UNMONITORED_AGENT_STOPPED: Hosts where OneAgent is stopped.
  • UNMONITORED_AGENT_RESTART_TRIGGERED: Hosts where OneAgent is being restarted.
  • UNMONITORED_AGENT_UNINSTALLED: Hosts where OneAgent is uninstalled.
  • UNMONITORED_AGENT_DISABLED: Hosts where OneAgent reported that it was disabled.
  • UNMONITORED_AGENT_UPGRADE_FAILED: Hosts where OneAgent has a potential update problem.
  • UNMONITORED_ID_CHANGED: Hosts where OneAgent has potentially changed ID during update.
  • UNMONITORED_AGENT_LOST: Hosts where OneAgent has been recognized to be unavailable due to server communication issues.
  • UNMONITORED_AGENT_UNREGISTERED: Hosts where a code module has been recognized to be unavailable because of shutdown.
  • UNMONITORED_AGENT_VERSION_REJECTED: Hosts where OneAgent was rejected because the version does not meet the minimum agent version requirement.
  • MONITORED: Hosts where OneAgent is enabled and active.
  • MONITORED_ENABLED: Hosts where OneAgent has been enabled in configuration.
  • MONITORED_AGENT_REGISTERED: Hosts where the new OneAgent has been recognized.
  • MONITORED_AGENT_UPGRADE_STARTED: Hosts where OneAgent has shutdown due to an update.
  • MONITORED_AGENT_ENABLED: Hosts where OneAgent reported that it was enabled.
  • MONITORED_AGENT_VERSION_ACCEPTED: Hosts where OneAgent was accepted because the version meets the minimum agent version requirement.
query optional
monitoringType string

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

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.

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.

query optional
updateStatus string

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

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.

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.

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.

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.

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

Response

Response codes

Code Description
200

Success

Response body

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.

monitoringType string

The monitoring mode of OneAgent.

autoUpdateSetting string

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

updateStatus string

The current update status of OneAgent.

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.

detailedAvailabilityState string

The detailed availability state of OneAgent.

currentActiveGateIds string[]

A list of ActiveGate IDs of ActiveGates to which OneAgent is currently 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.

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
zosTotalGeneralPurposeProcessors integer

Number of assigned processors for this LPAR.

agentVersion AgentVersion
zosVirtualization string

Type of virtualization on the mainframe.

zosTotalZiipProcessors integer

Number of assigned support processors for this LPAR.

hostGroup HostGroup
awsInstanceId string
publicIp string
osVersion string
kubernetesCluster string

The kubernetes cluster the entity is in.

osType string
openstackVmName string
gcePublicIpAddresses string[]

The public IP addresses of the Google Compute Engine.

cpuCores integer
azureVmScaleSetName string
vmwareName string
localHostName string
logicalCpus integer

The AIX instance logical CPU count.

awsNameTag string

The name inherited from AWS.

boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

awsInstanceType string
cloudType string
userLevel string
oneAgentCustomHostName string

The custom name defined in OneAgent config.

logicalCpuCores integer
gceInstanceId string

The Google Compute Engine instance ID.

isMonitoringCandidate boolean
paasType string
awsSecurityGroup string[]
zosCPUSerialNumber string

The CPU serial number.

openstackAvZone string
gceProject string

The Google Compute Engine project.

gceProjectId string

The Google Compute Engine numeric project ID.

localIp string
ipAddresses string[]
boshName string

The Cloud Foundry BOSH name.

autoScalingGroup string
azureVmName string
networkZoneId string

The ID of network zone the entity is in.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

esxiHostName string
openstackSecurityGroups string[]
openstackComputeNodeName string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

azureEnvironment string
azureHostNames string[]
consumedHostUnits string
boshInstanceId string

The Cloud Foundry BOSH instance ID.

boshInstanceName string

The Cloud Foundry BOSH instance name.

bitness string
azureResourceId string
gcpZone string

The Google Cloud Platform Zone.

openstackProjectName string
publicHostName string
zosSystemName string

Name of the system.

paasMemoryLimit integer
azureSku string
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

zosTotalPhysicalMemory integer

Memory assigned to the host (Terabyte).

softwareTechnologies TechnologyInfo[]
zosLpaName string

Name of the LPAR.

beanstalkEnvironmentName string
scaleSetName string
openStackInstaceType string
azureSiteNames string[]
boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

hypervisorType string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

zosCPUModelNumber string

The CPU model number.

paasAgentVersions AgentVersion[]

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

kubernetesLabels object

The kubernetes labels defined on the entity.

kubernetesNode string

The kubernetes node the entity is in.

azureComputeModeName string
osArchitecture string
amiId string
azureResourceGroupName string
azureZone string
gceMachineType string

The Google Compute Engine machine type.

virtualCpus integer

The AIX instance virtual CPU count.

azureVmSizeLabel string
monitoringMode string
gceInstanceName string

The Google Compute Engine instance name.

fromRelationships object

The TechnologyInfo object

Element Type Description
type string
edition string
version string

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 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.

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.