OneAgent on a host API

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

This request is currently in Preview and is subject to change. Changes may not be compatible with your current configuration.

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

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

query optional
relativeTime string

The relative timeframe, back from now.

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 following format: [context]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
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.

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 auto-update setting of OneAgent deployed on the host.

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:

  • DISABLED
  • ENABLED

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:

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

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

Information about the host.

faultyVersion boolean

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

active boolean

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

monitoringType string

The monitoring mode of OneAgent.

autoUpdateSetting string

The auto-update setting of OneAgent.

updateStatus string

The current update status of OneAgent.

availableVersions string[]

A list of versions OneAgent can be updated to.

availabilityState string

The availability state of OneAgent.

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

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.

fromRelationships object
toRelationships object
gceProjectId string

The Google Compute Engine numeric project ID.

userLevel string
openstackProjectName string
logicalCpus integer

The AIX instance logical CPU count.

osVersion string
logicalCpuCores integer
oneAgentCustomHostName string

The custom name defined in OneAgent config.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

gceMachineType string

The Google Compute Engine machine type.

boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

gcePublicIpAddresses InetAddress[]

The public IP addresses of the Google Compute Engine.

boshInstanceName string

The Cloud Foundry BOSH instance name.

amiId string
paasType string
boshName string

The Cloud Foundry BOSH name.

kubernetesNode string

The kubernetes node the entity is in.

paasAgentVersions AgentVersion[]

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

azureSiteNames string[]
autoScalingGroup string
openstackAvZone string
gceInstanceName string

The Google Compute Engine instance name.

gceProject string

The Google Compute Engine project.

gceInstanceId string

The Google Compute Engine instance ID.

azureHostNames string[]
scaleSetName string
publicHostName string
gcpZone string

The Google Cloud Platform Zone.

boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

azureSku string
softwareTechnologies TechnologyInfo[]
kubernetesLabels object

The kubernetes labels defined on the entity.

boshInstanceId string

The Cloud Foundry BOSH instance ID.

paasMemoryLimit integer
monitoringMode string
publicIp string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

awsInstanceType string
osArchitecture string
consumedHostUnits string
virtualCpus integer

The AIX instance virtual CPU count.

vmwareName string
openstackComputeNodeName string
ipAddresses string[]
isMonitoringCandidate boolean
hostGroup HostGroup

The host group the entity is in.

bitness string
cloudType string
beanstalkEnvironmentName string
openstackSecurityGroups string[]
osType string
awsInstanceId string
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

agentVersion AgentVersion

The version of OneAgent currently running on the entity.

azureComputeModeName string
awsNameTag string

The name inherited from AWS.

awsSecurityGroup string[]
openStackInstaceType string
azureVmName string
esxiHostName string
kubernetesCluster string

The kubernetes cluster the entity is in.

localIp string
cpuCores integer
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

openstackVmName string
hypervisorType string
localHostName string

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 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 TechnologyInfo object

Element Type Description
type string
edition string
version string

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.

sourceRevision string

A string representation of the SVN revision number.

timestamp string

A timestamp string: format "yyyymmdd-hhmmss

The InetAddress object

Element Type Description
canonicalHostName string
multicastAddress boolean
anyLocalAddress boolean
loopbackAddress boolean
linkLocalAddress boolean
siteLocalAddress boolean
mcglobal boolean
mcnodeLocal boolean
mclinkLocal boolean
mcsiteLocal boolean
mcorgLocal boolean
address string[]
hostAddress string
hostName 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.

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.