• 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 Host object

Information about the host.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the required entity.

Can be null.

displayNamestring

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

Can be null.

customizedNamestring

The customized name of the entity

Can be null.

discoveredNamestring

The discovered name of the entity

Can be null.

firstSeenTimestampinteger

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

Can be null.

lastSeenTimestampinteger

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

Can be null.

tagsTagInfo[]

The list of entity tags.

Can be null.

fromRelationshipsobject-

Can be null.

toRelationshipsobject-

Can be null.

awsNameTagstring

The name inherited from AWS.

Can be null.

gceMachineTypestring

The Google Compute Engine machine type.

Can be null.

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

Can be null.

amiIdstring-

Can be null.

boshNamestring

The Cloud Foundry BOSH name.

Can be null.

autoInjectionstring

Status of auto-injection

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

Can be null.

openstackVmNamestring-

Can be null.

boshInstanceIdstring

The Cloud Foundry BOSH instance ID.

Can be null.

azureResourceIdstring-

Can be null.

azureSkustring-
The element can hold these values
  • BASIC
  • DYNAMIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD

Can be null.

awsInstanceTypestring-

Can be null.

kubernetesLabelsobject

The kubernetes labels defined on the entity.

Can be null.

gceProjectIdstring

The Google Compute Engine numeric project ID.

Can be null.

publicIpstring-

Can be null.

simultaneousMultithreadinginteger

The AIX instance simultaneous threads count.

Can be null.

azureEnvironmentstring-

Can be null.

zosTotalZiipProcessorsinteger

Number of assigned support processors for this LPAR.

Can be null.

localHostNamestring-

Can be null.

scaleSetNamestring-

Can be null.

boshAvailabilityZonestring

The Cloud Foundry BOSH availability zone.

Can be null.

agentVersionAgentVersion

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

Can be null.

userLevelstring-
The element can hold these values
  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER

Can be null.

virtualCpusinteger

The AIX instance virtual CPU count.

Can be null.

autoScalingGroupstring-

Can be null.

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

Can be null.

gceInstanceIdstring

The Google Compute Engine instance ID.

Can be null.

kubernetesNodestring

The kubernetes node the entity is in.

Can be null.

zosSystemNamestring

Name of the system.

Can be null.

logicalCpuCoresinteger-

Can be null.

consumedHostUnitsstring-

Can be null.

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

Can be null.

ipAddressesstring[]-

Can be null.

networkZoneIdstring

The ID of network zone the entity is in.

Can be null.

beanstalkEnvironmentNamestring-

Can be null.

zosTotalGeneralPurposeProcessorsinteger

Number of assigned processors for this LPAR.

Can be null.

azureResourceGroupNamestring-

Can be null.

hostGroupHostGroup-

Can be null.

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

Can be null.

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

Can be null.

gcpZonestring

The Google Cloud Platform Zone.

Can be null.

publicHostNamestring-

Can be null.

azureVmScaleSetNamestring-

Can be null.

zosCPUSerialNumberstring

The CPU serial number.

Can be null.

openstackSecurityGroupsstring[]-

Can be null.

zosCPUModelNumberstring

The CPU model number.

Can be null.

logicalCpusinteger

The AIX instance logical CPU count.

Can be null.

monitoringModestring-
The element can hold these values
  • FULL_STACK
  • INFRASTRUCTURE
  • OFF

Can be null.

azureSiteNamesstring[]-

Can be null.

boshStemcellVersionstring

The Cloud Foundry BOSH stemcell version.

Can be null.

cloudPlatformVendorVersionstring

Defines the cloud platform vendor version.

Can be null.

kubernetesClusterstring

The kubernetes cluster the entity is in.

Can be null.

azureHostNamesstring[]-

Can be null.

gceInstanceNamestring

The Google Compute Engine instance name.

Can be null.

localIpstring-

Can be null.

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

Can be null.

softwareTechnologiesTechnologyInfo[]-

Can be null.

openstackAvZonestring-

Can be null.

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

Can be null.

vmwareNamestring-

Can be null.

osVersionstring-

Can be null.

awsInstanceIdstring-

Can be null.

esxiHostNamestring-

Can be null.

cpuCoresinteger-

Can be null.

zosVirtualizationstring

Type of virtualization on the mainframe.

Can be null.

awsSecurityGroupstring[]-

Can be null.

zosTotalPhysicalMemoryinteger

Memory assigned to the host (Terabyte).

Can be null.

boshDeploymentIdstring

The Cloud Foundry BOSH deployment ID.

Can be null.

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

Can be null.

gcePublicIpAddressesstring[]

The public IP addresses of the Google Compute Engine.

Can be null.

gceProjectstring

The Google Compute Engine project.

Can be null.

openStackInstaceTypestring-

Can be null.

boshInstanceNamestring

The Cloud Foundry BOSH instance name.

Can be null.

azureVmNamestring-

Can be null.

azureZonestring-

Can be null.

azureVmSizeLabelstring-

Can be null.

oneAgentCustomHostNamestring

The custom name defined in OneAgent config.

Can be null.

paasAgentVersionsAgentVersion[]

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

Can be null.

isMonitoringCandidateboolean-

Can be null.

openstackProjectNamestring-

Can be null.

zosLpaNamestring

Name of the LPAR.

Can be null.

openstackComputeNodeNamestring-

Can be null.

paasMemoryLimitinteger-

Can be null.

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.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

The AgentVersion object

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

ElementTypeDescription
majorinteger

The major version number.

Can be null.

minorinteger

The minor version number.

Can be null.

revisioninteger

The revision number.

Can be null.

timestampstring

A timestamp string: format "yyyymmdd-hhmmss

Can be null.

sourceRevisionstring

A string representation of the SVN revision number.

Can be null.

The HostGroup object

ElementTypeDescription
meIdstring

The Dynatrace entity ID of the host group.

Can be null.

namestring

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

Can be null.

The TechnologyInfo object

ElementTypeDescription
typestring-

Can be null.

editionstring-

Can be null.

versionstring-

Can be null.

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

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.