• Home
  • Dynatrace API
  • Environment
  • OneAgent on a host

OneAgent on a host API

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

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/oneagents
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/oneagents
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/oneagents

Authentication

To execute this request, you need an access token with one of the following scopes:

  • oneAgents.read
  • DataExport

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
includeDetailsboolean

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.

queryoptional
startTimestampinteger

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

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

queryoptional
endTimestampinteger

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

queryoptional
relativeTimestring

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.

The element can hold these values
  • 10mins
  • 15mins
  • 2hours
  • 30mins
  • 3days
  • 5mins
  • 6hours
  • day
  • hour
  • min
  • month
  • week
queryoptional
tagstring[]

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.

queryoptional
entitystring[]

Filters result to the specified hosts only.

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

queryoptional
managementZoneIdinteger

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

Specify the management zone ID here.

queryoptional
managementZonestring

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.

queryoptional
networkZoneIdstring

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.

queryoptional
hostGroupIdstring

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

Specify the Dynatrace entity ID of the required host group.

queryoptional
hostGroupNamestring

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

Specify the name of the required host group.

queryoptional
osTypestring

Filters the resulting set of hosts by the OS type.

The element can hold these values
  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS
queryoptional
cloudTypestring

Filters the resulting set of hosts by the cloud type.

The element can hold these values
  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE
  • UNRECOGNIZED
queryoptional
autoInjectionstring

Filters the resulting set of hosts by the auto-injection status.

The element can hold these values
  • DISABLED_MANUALLY
  • DISABLED_ON_INSTALLATION
  • DISABLED_ON_SANITY_CHECK
  • ENABLED
  • FAILED_ON_INSTALLATION
queryoptional
availabilityStatestring

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 element can hold these values
  • CRASHED
  • LOST
  • MONITORED
  • PRE_MONITORED
  • SHUTDOWN
  • UNEXPECTED_SHUTDOWN
  • UNKNOWN
  • UNMONITORED
queryoptional
detailedAvailabilityStatestring

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.
  • LOST_AGENT_UPGRADE_FAILED: Hosts where OneAgent has a potential update problem due to inactivity after update.
  • 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_STOPPED: Hosts where OneAgent has shutdown because the host has stopped.
  • 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.
The element can hold these values
  • CRASHED_FAILURE
  • CRASHED_UNKNOWN
  • LOST_AGENT_UPGRADE_FAILED
  • LOST_CONNECTION
  • LOST_UNKNOWN
  • MONITORED
  • MONITORED_AGENT_ENABLED
  • MONITORED_AGENT_REGISTERED
  • MONITORED_AGENT_UPGRADE_STARTED
  • MONITORED_AGENT_VERSION_ACCEPTED
  • MONITORED_ENABLED
  • PRE_MONITORED
  • SHUTDOWN_AGENT_LOST
  • SHUTDOWN_GRACEFUL
  • SHUTDOWN_SPOT_INSTANCE
  • SHUTDOWN_STOPPED
  • SHUTDOWN_UNKNOWN
  • SHUTDOWN_UNKNOWN_UNEXPECTED
  • UNKNOWN
  • UNMONITORED_AGENT_DISABLED
  • UNMONITORED_AGENT_LOST
  • UNMONITORED_AGENT_RESTART_TRIGGERED
  • UNMONITORED_AGENT_STOPPED
  • UNMONITORED_AGENT_UNINSTALLED
  • UNMONITORED_AGENT_UNREGISTERED
  • UNMONITORED_AGENT_UPGRADE_FAILED
  • UNMONITORED_AGENT_VERSION_REJECTED
  • UNMONITORED_DISABLED
  • UNMONITORED_ID_CHANGED
  • UNMONITORED_TERMINATED
  • UNMONITORED_UNKNOWN
queryoptional
monitoringTypestring

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

The element can hold these values
  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
  • STANDALONE
queryoptional
agentVersionIsstring

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

Specify the comparison operator here.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
agentVersionNumberstring

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.

queryoptional
autoUpdateSettingstring

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

The element can hold these values
  • ENABLED
  • DISABLED
queryoptional
updateStatusstring

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

The element can hold these values
  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
queryoptional
faultyVersionboolean

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

queryoptional
activeGateIdstring

Filters the resulting set of hosts to those that are currently connected to the ActiveGate with the specified ID.

Use DIRECT_COMMUNICATION keyword to find the hosts not connected to any ActiveGate.

queryoptional
technologyModuleTypestring

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

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

The element can hold these values
  • APACHE
  • DOT_NET
  • DUMPPROC
  • GO
  • IBM_INTEGRATION_BUS
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • NETTRACER
  • NETWORK
  • NGINX
  • NODE_JS
  • OPENTRACINGNATIVE
  • PHP
  • PROCESS
  • PYTHON
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • Z_OS
queryoptional
technologyModuleVersionIsstring

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 specified, the code module has to match all the filters.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
technologyModuleVersionNumberstring

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 specified, the code module has to match all the filters.

queryoptional
technologyModuleFaultyVersionboolean

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 specified, the code module has to match all the filters.

queryoptional
pluginNamestring

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 specified, the plugin has to match all the filters.

queryoptional
pluginVersionIsstring

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 specified, the plugin has to match all the filters.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
pluginVersionNumberstring

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 specified, the plugin has to match all the filters.

queryoptional
pluginStatestring

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

The element can hold these values
  • 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
queryoptional
nextPageKeystring

The cursor for the next page of results, if results do not fit on one page. You can find the cursor value on the current page of the response, in the nextPageKey field.

To obtain subsequent pages, you must specify this cursor value in your query, and keep all other query parameters as they were in the original request.

If you don't specify the cursor, the first page will always be returned.

queryoptional

Response

Response codes

CodeTypeDescription
200HostsListPage

Success

Response body objects

The HostsListPage object

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

ElementTypeDescription
percentageOfEnvironmentSearchednumber

The progress of the environment search, in percent.

nextPageKeystring

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.

hostsHostAgentInfo[]

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

The HostAgentInfo object

OneAgent deployment on a host.

ElementTypeDescription
hostInfoHost

Information about the host.

faultyVersionboolean

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

activeboolean

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

configuredMonitoringModestring

Configured monitoring mode of OneAgent.

The element can hold these values
  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
monitoringTypestring

The monitoring mode of OneAgent.

The element can hold these values
  • CLOUD_INFRASTRUCTURE
  • FULL_STACK
  • STANDALONE
autoUpdateSettingstring

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

The element can hold these values
  • ENABLED
  • DISABLED
updateStatusstring

The current update status of OneAgent.

The element can hold these values
  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
availableVersionsstring[]

A list of versions OneAgent can be updated to.

configuredMonitoringEnabledboolean

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

availabilityStatestring

The availability state of OneAgent.

The element can hold these values
  • CRASHED
  • LOST
  • MONITORED
  • PRE_MONITORED
  • SHUTDOWN
  • UNEXPECTED_SHUTDOWN
  • UNKNOWN
  • UNMONITORED
detailedAvailabilityStatestring

The detailed availability state of OneAgent.

The element can hold these values
  • CRASHED_FAILURE
  • CRASHED_UNKNOWN
  • LOST_AGENT_UPGRADE_FAILED
  • LOST_CONNECTION
  • LOST_UNKNOWN
  • MONITORED
  • MONITORED_AGENT_ENABLED
  • MONITORED_AGENT_REGISTERED
  • MONITORED_AGENT_UPGRADE_STARTED
  • MONITORED_AGENT_VERSION_ACCEPTED
  • MONITORED_ENABLED
  • PRE_MONITORED
  • SHUTDOWN_AGENT_LOST
  • SHUTDOWN_GRACEFUL
  • SHUTDOWN_SPOT_INSTANCE
  • SHUTDOWN_STOPPED
  • SHUTDOWN_UNKNOWN
  • SHUTDOWN_UNKNOWN_UNEXPECTED
  • UNKNOWN
  • UNMONITORED_AGENT_DISABLED
  • UNMONITORED_AGENT_LOST
  • UNMONITORED_AGENT_RESTART_TRIGGERED
  • UNMONITORED_AGENT_STOPPED
  • UNMONITORED_AGENT_UNINSTALLED
  • UNMONITORED_AGENT_UNREGISTERED
  • UNMONITORED_AGENT_UPGRADE_FAILED
  • UNMONITORED_AGENT_VERSION_REJECTED
  • UNMONITORED_DISABLED
  • UNMONITORED_ID_CHANGED
  • UNMONITORED_TERMINATED
  • UNMONITORED_UNKNOWN
currentActiveGateIdinteger

DEPRECATED

This field is deprecated and provided for backward compatibility.

Use the currentActiveGateIds field instead.

currentActiveGateIdsstring[]

The list of ActiveGate IDs of ActiveGates to which OneAgent is currently connected.

currentNetworkZoneIdstring

The ID of the network zone that OneAgent is using.

modulesModuleInfo[]

A list of code modules deployed on the host.

pluginsPluginInfo[]

A list of plugins deployed on the host.

The Host object

Information about the host.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the required entity.

displayNamestring

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

customizedNamestring

The customized name of the entity

discoveredNamestring

The discovered name of the entity

firstSeenTimestampinteger

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

lastSeenTimestampinteger

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

tagsTagInfo[]

The list of entity tags.

fromRelationshipsobject-
toRelationshipsobject-
kubernetesNodestring

The kubernetes node the entity is in.

openStackInstaceTypestring-
boshNamestring

The Cloud Foundry BOSH name.

zosLpaNamestring

Name of the LPAR.

openstackSecurityGroupsstring[]-
azureVmNamestring-
localIpstring-
boshInstanceNamestring

The Cloud Foundry BOSH instance name.

gceInstanceNamestring

The Google Compute Engine instance name.

awsInstanceTypestring-
monitoringModestring-
The element can hold these values
  • FULL_STACK
  • INFRASTRUCTURE
  • OFF
beanstalkEnvironmentNamestring-
cpuCoresinteger-
osArchitecturestring-
The element can hold these values
  • ARM
  • IA64
  • PARISC
  • PPC
  • PPCLE
  • S390
  • SPARC
  • X86
  • ZOS
kubernetesLabelsobject

The kubernetes labels defined on the entity.

zosVirtualizationstring

Type of virtualization on the mainframe.

osTypestring-
The element can hold these values
  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS
hostGroupHostGroup-
amiIdstring-
managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

azureVmSizeLabelstring-
vmwareNamestring-
autoScalingGroupstring-
kubernetesClusterstring

The kubernetes cluster the entity is in.

boshInstanceIdstring

The Cloud Foundry BOSH instance ID.

paasTypestring-
The element can hold these values
  • AWS_ECS_EC2
  • AWS_ECS_FARGATE
  • AWS_LAMBDA
  • AZURE_FUNCTIONS
  • AZURE_WEBSITES
  • CLOUD_FOUNDRY
  • GOOGLE_APP_ENGINE
  • GOOGLE_CLOUD_RUN
  • HEROKU
  • KUBERNETES
  • OPENSHIFT
azureZonestring-
zosTotalGeneralPurposeProcessorsinteger

Number of assigned processors for this LPAR.

azureComputeModeNamestring-
The element can hold these values
  • DEDICATED
  • SHARED
softwareTechnologiesTechnologyInfo[]-
openstackProjectNamestring-
osVersionstring-
boshStemcellVersionstring

The Cloud Foundry BOSH stemcell version.

openstackComputeNodeNamestring-
bitnessstring-
The element can hold these values
  • 32bit
  • 64bit
gceProjectIdstring

The Google Compute Engine numeric project ID.

gceProjectstring

The Google Compute Engine project.

virtualCpusinteger

The AIX instance virtual CPU count.

boshDeploymentIdstring

The Cloud Foundry BOSH deployment ID.

autoInjectionstring

Status of auto-injection

The element can hold these values
  • DISABLED_MANUALLY
  • DISABLED_ON_INSTALLATION
  • DISABLED_ON_SANITY_CHECK
  • ENABLED
  • FAILED_ON_INSTALLATION
cloudPlatformVendorVersionstring

Defines the cloud platform vendor version.

publicIpstring-
azureSiteNamesstring[]-
zosTotalPhysicalMemoryinteger

Memory assigned to the host (Terabyte).

awsNameTagstring

The name inherited from AWS.

oneAgentCustomHostNamestring

The custom name defined in OneAgent config.

zosCPUModelNumberstring

The CPU model number.

azureHostNamesstring[]-
logicalCpusinteger

The AIX instance logical CPU count.

networkZoneIdstring

The ID of network zone the entity is in.

publicHostNamestring-
openstackVmNamestring-
boshAvailabilityZonestring

The Cloud Foundry BOSH availability zone.

simultaneousMultithreadinginteger

The AIX instance simultaneous threads count.

logicalCpuCoresinteger-
gceMachineTypestring

The Google Compute Engine machine type.

userLevelstring-
The element can hold these values
  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER
cloudTypestring-
The element can hold these values
  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE
  • UNRECOGNIZED
azureSkustring-
The element can hold these values
  • BASIC
  • DYNAMIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD
paasAgentVersionsAgentVersion[]

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

paasMemoryLimitinteger-
awsInstanceIdstring-
ipAddressesstring[]-
zosTotalZiipProcessorsinteger

Number of assigned support processors for this LPAR.

esxiHostNamestring-
hypervisorTypestring-
The element can hold these values
  • AHV
  • AWS_NITRO
  • GVISOR
  • HYPERV
  • KVM
  • LPAR
  • QEMU
  • UNRECOGNIZED
  • VIRTUALBOX
  • VMWARE
  • WPAR
  • XEN
gceInstanceIdstring

The Google Compute Engine instance ID.

azureVmScaleSetNamestring-
scaleSetNamestring-
zosSystemNamestring

Name of the system.

localHostNamestring-
zosCPUSerialNumberstring

The CPU serial number.

azureEnvironmentstring-
consumedHostUnitsstring-
azureResourceGroupNamestring-
isMonitoringCandidateboolean-
agentVersionAgentVersion

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

azureResourceIdstring-
gcePublicIpAddressesstring[]

The public IP addresses of the Google Compute Engine.

openstackAvZonestring-
awsSecurityGroupstring[]-
gcpZonestring

The Google Cloud Platform Zone.

The TagInfo object

Tag of a Dynatrace entity.

ElementTypeDescription
contextstring

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

Custom tags use the CONTEXTLESS value.

The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

The HostGroup object

ElementTypeDescription
meIdstring

The Dynatrace entity ID of the host group.

namestring

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

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

The TechnologyInfo object

ElementTypeDescription
typestring-
editionstring-
versionstring-

The AgentVersion object

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

ElementTypeDescription
majorinteger

The major version number.

minorinteger

The minor version number.

revisioninteger

The revision number.

timestampstring

A timestamp string: format "yyyymmdd-hhmmss

sourceRevisionstring

A string representation of the SVN revision number.

The ModuleInfo object

OneAgent code module.

ElementTypeDescription
moduleTypestring

The type of the code module.

The element can hold these values
  • APACHE
  • DOT_NET
  • DUMPPROC
  • GO
  • IBM_INTEGRATION_BUS
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • NETTRACER
  • NETWORK
  • NGINX
  • NODE_JS
  • OPENTRACINGNATIVE
  • PHP
  • PROCESS
  • PYTHON
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • Z_OS
instancesModuleInstance[]

A list of instances of the code module.

The ModuleInstance object

An instance of the OneAgent code module.

ElementTypeDescription
instanceNamestring

The name of the instance.

moduleVersionstring

The version of the code module.

faultyVersionboolean

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

activeboolean

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

The PluginInfo object

OneAgent plugin.

ElementTypeDescription
pluginNamestring

The name of the plugin.

instancesPluginInstance[]

A list of instances of the plugin.

The PluginInstance object

An instance of the OneAgent plugin.

ElementTypeDescription
pluginVersionstring

The version of the plugin.

statestring

The state of the plugin instance.

Response body JSON model

json
{ "percentageOfEnvironmentSearched": 1, "nextPageKey": "string", "hosts": [ { "hostInfo": { "entityId": "string", "displayName": "string", "customizedName": "string", "discoveredName": "string", "firstSeenTimestamp": 1, "lastSeenTimestamp": 1, "tags": [ { "context": "AWS", "key": "string", "value": "string" } ], "fromRelationships": { "isNetworkClientOfHost": [ "string" ] }, "toRelationships": { "isSiteOf": [ "string" ], "isProcessOf": [ "string" ], "isNetworkClientOfHost": [ "string" ], "runsOn": [ "string" ] }, "kubernetesNode": "string", "openStackInstaceType": "string", "boshName": "string", "zosLpaName": "string", "openstackSecurityGroups": [ "string" ], "azureVmName": "string", "localIp": "string", "boshInstanceName": "string", "gceInstanceName": "string", "awsInstanceType": "string", "monitoringMode": "FULL_STACK", "beanstalkEnvironmentName": "string", "cpuCores": 1, "osArchitecture": "ARM", "kubernetesLabels": {}, "zosVirtualization": "string", "osType": "AIX", "hostGroup": { "meId": "string", "name": "string" }, "amiId": "string", "managementZones": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" } ], "azureVmSizeLabel": "string", "vmwareName": "string", "autoScalingGroup": "string", "kubernetesCluster": "string", "boshInstanceId": "string", "paasType": "AWS_ECS_EC2", "azureZone": "string", "zosTotalGeneralPurposeProcessors": 1, "azureComputeModeName": "DEDICATED", "softwareTechnologies": [ { "type": "string", "edition": "string", "version": "string" } ], "openstackProjectName": "string", "osVersion": "string", "boshStemcellVersion": "string", "openstackComputeNodeName": "string", "bitness": "32bit", "gceProjectId": "string", "gceProject": "string", "virtualCpus": 1, "boshDeploymentId": "string", "autoInjection": "DISABLED_MANUALLY", "cloudPlatformVendorVersion": "string", "publicIp": "string", "azureSiteNames": [ "string" ], "zosTotalPhysicalMemory": 1, "awsNameTag": "string", "oneAgentCustomHostName": "string", "zosCPUModelNumber": "string", "azureHostNames": [ "string" ], "logicalCpus": 1, "networkZoneId": "string", "publicHostName": "string", "openstackVmName": "string", "boshAvailabilityZone": "string", "simultaneousMultithreading": 1, "logicalCpuCores": 1, "gceMachineType": "string", "userLevel": "NON_SUPERUSER", "cloudType": "AZURE", "azureSku": "BASIC", "paasAgentVersions": [ { "major": 1, "minor": 1, "revision": 1, "timestamp": "string", "sourceRevision": "string" } ], "paasMemoryLimit": 1, "awsInstanceId": "string", "ipAddresses": [ "string" ], "zosTotalZiipProcessors": 1, "esxiHostName": "string", "hypervisorType": "AHV", "gceInstanceId": "string", "azureVmScaleSetName": "string", "scaleSetName": "string", "zosSystemName": "string", "localHostName": "string", "zosCPUSerialNumber": "string", "azureEnvironment": "string", "consumedHostUnits": "string", "azureResourceGroupName": "string", "isMonitoringCandidate": true, "agentVersion": {}, "azureResourceId": "string", "gcePublicIpAddresses": [ "string" ], "openstackAvZone": "string", "awsSecurityGroup": [ "string" ], "gcpZone": "string" }, "faultyVersion": true, "active": true, "configuredMonitoringMode": "CLOUD_INFRASTRUCTURE", "monitoringType": "CLOUD_INFRASTRUCTURE", "autoUpdateSetting": "ENABLED", "updateStatus": "INCOMPATIBLE", "availableVersions": [ "string" ], "configuredMonitoringEnabled": true, "availabilityState": "CRASHED", "detailedAvailabilityState": "CRASHED_FAILURE", "currentActiveGateId": 1, "currentActiveGateIds": [ "string" ], "currentNetworkZoneId": "string", "modules": [ { "moduleType": "APACHE", "instances": [ { "instanceName": "string", "moduleVersion": "string", "faultyVersion": true, "active": true } ] } ], "plugins": [ { "pluginName": "string", "instances": [ { "pluginVersion": "string", "state": "string" } ] } ] } ] }
Related topics
  • OneAgent configuration on a host API

    Manage the configuration of OneAgent instances on your hosts via the Dynatrace API.