• Home
  • Dynatrace API
  • Environment
  • Topology and Smartscape v1
  • Hosts
  • GET all hosts

Hosts API - GET all hosts

We have a new version of this API—Entity API v2. Check it out!

Gets the list of all hosts in your Dynatrace environment, along with their parameters.

The full list can be lengthy, so you can narrow it down by specifying filter parameters, like tags. See the Parameters section for more details.

You can additionally limit the output by using the pagination:

  1. Specify the number of results per page in the pageSize query parameter.
  2. Then use the cursor from the Next-Page-Key response header in the nextPageKey query parameter to obtain subsequent pages.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts

Authentication

To execute this request, you need an access token with Access problem and event feed, metrics, and topology (DataExport) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The timeframe is restricted to a maximum period of 3 days.

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

queryoptional
relativeTimestring

The relative timeframe, back from now.

The element can hold these values
  • min
  • 5mins
  • 10mins
  • 15mins
  • 30mins
  • hour
  • 2hours
  • 6hours
  • day
  • 3days
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
showMonitoringCandidatesboolean

Includes (true) or excludes (false) a monitoring candidate in the response.

Monitoring candidates are network entities that are detected but not monitored.

queryoptional
entitystring[]

Filters result to the specified hosts only.

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

queryoptional
managementZoneinteger

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

queryoptional
hostGroupIdstring

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

Specify the Dynatrace IDs of the host group you're interested in.

queryoptional
hostGroupNamestring

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

Specify the name of the host group you're interested in.

queryoptional
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
pageSizeinteger

The number of hosts per result page.

If not set, pagination is not used and the result contains all hosts fitting the specified filtering criteria.

queryoptional
nextPageKeystring

The cursor for the next page of results. You can find it in the Next-Page-Key header of the previous response.

If you're using pagination, the first page is always returned without this cursor.

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

queryoptional

Response

Response codes

CodeTypeDescription
200Host[]

Success

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The ResponseBody object

The object doesn't provide any parameters.

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

The Google Compute Engine project.

awsInstanceTypestring-
cloudTypestring-
The element can hold these values
  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE
  • UNRECOGNIZED
openStackInstaceTypestring-
gceInstanceIdstring

The Google Compute Engine instance ID.

beanstalkEnvironmentNamestring-
azureResourceGroupNamestring-
consumedHostUnitsstring-
publicIpstring-
simultaneousMultithreadinginteger

The AIX instance simultaneous threads count.

gcpZonestring

The Google Cloud Platform Zone.

zosTotalZiipProcessorsinteger

Number of assigned support processors for this LPAR.

boshInstanceNamestring

The Cloud Foundry BOSH instance name.

azureSiteNamesstring[]-
vmwareNamestring-
gceProjectIdstring

The Google Compute Engine numeric project ID.

hostGroupHostGroup-
azureVmScaleSetNamestring-
gcePublicIpAddressesstring[]

The public IP addresses of the Google Compute Engine.

openstackComputeNodeNamestring-
esxiHostNamestring-
osTypestring-
The element can hold these values
  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS
awsNameTagstring

The name inherited from AWS.

ipAddressesstring[]-
paasAgentVersionsAgentVersion[]

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

boshAvailabilityZonestring

The Cloud Foundry BOSH availability zone.

hypervisorTypestring-
The element can hold these values
  • AHV
  • HYPERV
  • KVM
  • LPAR
  • QEMU
  • UNRECOGNIZED
  • VIRTUALBOX
  • VMWARE
  • WPAR
  • XEN
cpuCoresinteger-
autoInjectionstring

Status of auto-injection

The element can hold these values
  • DISABLED_MANUALLY
  • DISABLED_ON_INSTALLATION
  • DISABLED_ON_SANITY_CHECK
  • ENABLED
  • FAILED_ON_INSTALLATION
monitoringModestring-
The element can hold these values
  • FULL_STACK
  • INFRASTRUCTURE
  • OFF
zosTotalPhysicalMemoryinteger

Memory assigned to the host (Terabyte).

zosLpaNamestring

Name of the LPAR.

logicalCpuCoresinteger-
awsInstanceIdstring-
gceInstanceNamestring

The Google Compute Engine instance name.

openstackVmNamestring-
zosTotalGeneralPurposeProcessorsinteger

Number of assigned processors for this LPAR.

zosCPUSerialNumberstring

The CPU serial number.

osVersionstring-
azureZonestring-
softwareTechnologiesTechnologyInfo[]-
zosCPUModelNumberstring

The CPU model number.

isMonitoringCandidateboolean-
gceMachineTypestring

The Google Compute Engine machine type.

oneAgentCustomHostNamestring

The custom name defined in OneAgent config.

kubernetesLabelsobject

The kubernetes labels defined on the entity.

azureComputeModeNamestring-
The element can hold these values
  • DEDICATED
  • SHARED
virtualCpusinteger

The AIX instance virtual CPU count.

boshDeploymentIdstring

The Cloud Foundry BOSH deployment ID.

awsSecurityGroupstring[]-
kubernetesClusterstring

The kubernetes cluster the entity is in.

boshNamestring

The Cloud Foundry BOSH name.

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

azureHostNamesstring[]-
bitnessstring-
The element can hold these values
  • 32bit
  • 64bit
openstackProjectNamestring-
userLevelstring-
The element can hold these values
  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER
openstackAvZonestring-
azureSkustring-
The element can hold these values
  • BASIC
  • DYNAMIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD
zosSystemNamestring

Name of the system.

scaleSetNamestring-
publicHostNamestring-
zosVirtualizationstring

Type of virtualization on the mainframe.

autoScalingGroupstring-
azureEnvironmentstring-
boshInstanceIdstring

The Cloud Foundry BOSH instance ID.

paasMemoryLimitinteger-
boshStemcellVersionstring

The Cloud Foundry BOSH stemcell version.

openstackSecurityGroupsstring[]-
agentVersionAgentVersion

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

localIpstring-
amiIdstring-
osArchitecturestring-
The element can hold these values
  • ARM
  • IA64
  • PARISC
  • PPC
  • PPCLE
  • S390
  • SPARC
  • X86
  • ZOS
azureVmSizeLabelstring-
cloudPlatformVendorVersionstring

Defines the cloud platform vendor version.

paasTypestring-
The element can hold these values
  • AWS_ECS_EC2
  • AWS_ECS_FARGATE
  • AWS_LAMBDA
  • AZURE_FUNCTIONS
  • AZURE_WEBSITES
  • CLOUD_FOUNDRY
  • GOOGLE_APP_ENGINE
  • HEROKU
  • KUBERNETES
  • OPENSHIFT
azureResourceIdstring-
localHostNamestring-
azureVmNamestring-
networkZoneIdstring

The ID of network zone the entity is in.

logicalCpusinteger

The AIX instance logical CPU count.

kubernetesNodestring

The kubernetes node the entity is in.

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

ElementTypeDescription
typestring-
editionstring-
versionstring-

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.

Response body JSON model

json
[ { "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" ] }, "gceProject": "string", "awsInstanceType": "string", "cloudType": "AZURE", "openStackInstaceType": "string", "gceInstanceId": "string", "beanstalkEnvironmentName": "string", "azureResourceGroupName": "string", "consumedHostUnits": "string", "publicIp": "string", "simultaneousMultithreading": 1, "gcpZone": "string", "zosTotalZiipProcessors": 1, "boshInstanceName": "string", "azureSiteNames": [ "string" ], "vmwareName": "string", "gceProjectId": "string", "hostGroup": { "meId": "string", "name": "string" }, "azureVmScaleSetName": "string", "gcePublicIpAddresses": [ "string" ], "openstackComputeNodeName": "string", "esxiHostName": "string", "osType": "AIX", "awsNameTag": "string", "ipAddresses": [ "string" ], "paasAgentVersions": [ { "major": 1, "minor": 1, "revision": 1, "timestamp": "string", "sourceRevision": "string" } ], "boshAvailabilityZone": "string", "hypervisorType": "AHV", "cpuCores": 1, "autoInjection": "DISABLED_MANUALLY", "monitoringMode": "FULL_STACK", "zosTotalPhysicalMemory": 1, "zosLpaName": "string", "logicalCpuCores": 1, "awsInstanceId": "string", "gceInstanceName": "string", "openstackVmName": "string", "zosTotalGeneralPurposeProcessors": 1, "zosCPUSerialNumber": "string", "osVersion": "string", "azureZone": "string", "softwareTechnologies": [ { "type": "string", "edition": "string", "version": "string" } ], "zosCPUModelNumber": "string", "isMonitoringCandidate": true, "gceMachineType": "string", "oneAgentCustomHostName": "string", "kubernetesLabels": {}, "azureComputeModeName": "DEDICATED", "virtualCpus": 1, "boshDeploymentId": "string", "awsSecurityGroup": [ "string" ], "kubernetesCluster": "string", "boshName": "string", "managementZones": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" } ], "azureHostNames": [ "string" ], "bitness": "32bit", "openstackProjectName": "string", "userLevel": "NON_SUPERUSER", "openstackAvZone": "string", "azureSku": "BASIC", "zosSystemName": "string", "scaleSetName": "string", "publicHostName": "string", "zosVirtualization": "string", "autoScalingGroup": "string", "azureEnvironment": "string", "boshInstanceId": "string", "paasMemoryLimit": 1, "boshStemcellVersion": "string", "openstackSecurityGroups": [ "string" ], "agentVersion": {}, "localIp": "string", "amiId": "string", "osArchitecture": "ARM", "azureVmSizeLabel": "string", "cloudPlatformVendorVersion": "string", "paasType": "AWS_ECS_EC2", "azureResourceId": "string", "localHostName": "string", "azureVmName": "string", "networkZoneId": "string", "logicalCpus": 1, "kubernetesNode": "string" } ]

Response headers

HeaderTypeDescription
Total-CountintegerThe estimated number of results.
Next-Page-KeystringThe cursor for the next page of results. Without it you'll get the first page again.
Page-SizestringThe maximum number of results per page.

Example

In this example, the request lists all hosts in the environment.

The API token is passed in the Authorization header.

The result is truncated to two entries.

Curl

shell
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts

Response body

json
[ { "entityId": "HOST-B7A6F9EE9F366CB5", "displayName": "tag009", "discoveredName": "tag009", "firstSeenTimestamp": 1538473087608, "lastSeenTimestamp": 1538641647769, "tags": [ { "context": "CONTEXTLESS", "key": "loadtest" }, { "context": "CONTEXTLESS", "key": "host tag" } ], "fromRelationships": { "isNetworkClientOfHost": [ "HOST-80FF8584D8954C1D", "HOST-A281F848361E79A1" ] }, "toRelationships": { "isProcessOf": [ "PROCESS_GROUP_INSTANCE-9146FB8A6A155F93" ], "isSiteOf": [ "GEOLOC_SITE-F72DF471AE5F56F6" ], "isNetworkClientOfHost": [ "HOST-80FF8584D8954C1D" ], "runsOn": [ "PROCESS_GROUP-83D74C22E79B074F" ] }, "osType": "LINUX", "osArchitecture": "X86", "osVersion": "Ubuntu 18.04.1", "ipAddresses": [ "127.0.0.1", "192.168.1.1" ], "bitness": "64bit", "cpuCores": 4, "logicalCpuCores": 8, "consumedHostUnits": 2, "managementZones": [ { "id": "6164525246045854296", "name": "Zone Service E" }, { "id": "5678", "name": "Infrastructure Linux" } ] }, { "entityId": "HOST-2540A456786EEBCA", "displayName": "RD40", "discoveredName": "RD40", "firstSeenTimestamp": 1536455342329, "lastSeenTimestamp": 1538661752404, "tags": [ { "context": "CONTEXTLESS", "key": "loadtest" }, ], "fromRelationships": {}, "toRelationships": { "isProcessOf": [ "PROCESS_GROUP_INSTANCE-0014EF34F2D03461", "PROCESS_GROUP_INSTANCE-306710DC5239D390" ], "isSiteOf": [ "GEOLOC_SITE-2D77938DBFF32A41", "AZURE_REGION-D4D61746B479FE16" ], "runsOn": [ "PROCESS_GROUP-1527B48A2A57385A", "PROCESS_GROUP-25544B628ABEDFAB" ] }, "osType": "WINDOWS", "osArchitecture": "X86", "osVersion": "Windows Server 2016 Datacenter", "hypervisorType": "HYPERV", "ipAddresses": [ "127.0.0.1" ], "bitness": "64bit", "cpuCores": 2, "logicalCpuCores": 2, "cloudType": "AZURE", "paasType": "AZURE_WEBSITES", "paasMemoryLimit": 3583, "azureHostNames": [ "contosomomentshkai3q.azurewebsites.net" ], "azureSiteNames": [ "contosomomentshkai3q" ], "azureComputeModeName": "DEDICATED", "azureSku": "STANDARD", "consumedHostUnits": 0.25, "managementZones": [ { "id": "5130731705740636866", "name": "Windows" } ] } ]

Response code

200

Related topics
  • Hosts

    Learn how to get started with host monitoring, understand which measures contribute to host health, how to set up custom host names, and more.