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:

Specify the number of results per page in the pageSize query parameter.
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.

GET	Managed	`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 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

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

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	required
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	required
relativeTime	string	The relative timeframe, back from now. The element can hold these values `min` `5mins` `10mins` `15mins` `30mins` `hour` `2hours` `6hours` `day` `3days`	query	required
tag	string[]	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	required
showMonitoringCandidates	boolean	Includes (`true`) or excludes (`false`) a monitoring candidate in the response. Monitoring candidates are network entities that are detected but not monitored.	query	required
entity	string[]	Filters result to the specified hosts only. To specify several hosts use the following format: `entity=ID1&entity=ID2`.	query	required
managementZone	integer	Only return hosts that are part of the specified management zone.	query	required
hostGroupId	string	Filters the resulting set of hosts by the specified host group. Specify the Dynatrace IDs of the host group you're interested in.	query	required
hostGroupName	string	Filters the resulting set of hosts by the specified host group. Specify the name of the host group you're interested in.	query	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	required
pageSize	integer	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.	query	required
nextPageKey	string	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.	query	required

Response

Response codes

Code	Type	Description
200	Host[]	Success
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `Host` object

Information about the host.

Element	Type	Description	Required
entityId	string	The Dynatrace entity ID of the required entity.	optional
displayName	string	The name of the Dynatrace entity as displayed in the UI.	optional
customizedName	string	The customized name of the entity	optional
discoveredName	string	The discovered name of the entity	optional
firstSeenTimestamp	integer	The timestamp of when the entity was first detected, in UTC milliseconds	optional
lastSeenTimestamp	integer	The timestamp of when the entity was last detected, in UTC milliseconds	optional
tags	TagInfo[]	The list of entity tags.	optional
toRelationships	object	-	optional
zosSystemName	string	Name of the system.	optional
zosCPUSerialNumber	string	The CPU serial number.	optional
zosVirtualization	string	Type of virtualization on the mainframe.	optional
zosLpaName	string	Name of the LPAR.	optional
osType	string	- The element can hold these values `AIX` `DARWIN` `HPUX` `LINUX` `SOLARIS` `WINDOWS` `ZOS`	optional
zosTotalPhysicalMemory	integer	Memory assigned to the host (Terabyte).	optional
publicHostName	string	-	optional
osVersion	string	-	optional
boshStemcellVersion	string	The Cloud Foundry BOSH stemcell version.	optional
publicIp	string	-	optional
kubernetesCluster	string	The kubernetes cluster the entity is in.	optional
azureResourceId	string	-	optional
boshInstanceName	string	The Cloud Foundry BOSH instance name.	optional
zosTotalGeneralPurposeProcessors	integer	Number of assigned processors for this LPAR.	optional
boshInstanceId	string	The Cloud Foundry BOSH instance ID.	optional
scaleSetName	string	-	optional
boshName	string	The Cloud Foundry BOSH name.	optional
boshAvailabilityZone	string	The Cloud Foundry BOSH availability zone.	optional
bitness	string	- The element can hold these values `32bit` `64bit`	optional
gceProjectId	string	The Google Compute Engine numeric project ID.	optional
openstackComputeNodeName	string	-	optional
paasAgentVersions	AgentVersion[]	The versions of the PaaS agents currently running on the entity.	optional
gcePublicIpAddresses	string[]	The public IP addresses of the Google Compute Engine.	optional
openstackSecurityGroups	string[]	-	optional
beanstalkEnvironmentName	string	-	optional
awsNameTag	string	The name inherited from AWS.	optional
azureSiteNames	string[]	-	optional
openStackInstaceType	string	-	optional
userLevel	string	- The element can hold these values `NON_SUPERUSER` `NON_SUPERUSER_STRICT` `SUPERUSER`	optional
hypervisorType	string	- The element can hold these values `AHV` `HYPERV` `KVM` `LPAR` `QEMU` `UNRECOGNIZED` `VIRTUALBOX` `VMWARE` `WPAR` `XEN`	optional
cpuCores	integer	-	optional
virtualCpus	integer	The AIX instance virtual CPU count.	optional
azureComputeModeName	string	- The element can hold these values `DEDICATED` `SHARED`	optional
vmwareName	string	-	optional
hostGroup	HostGroup	-	optional
logicalCpuCores	integer	-	optional
gcpZone	string	The Google Cloud Platform Zone.	optional
monitoringMode	string	- The element can hold these values `FULL_STACK` `INFRASTRUCTURE` `OFF`	optional
azureVmScaleSetName	string	-	optional
awsInstanceId	string	-	optional
openstackVmName	string	-	optional
gceInstanceId	string	The Google Compute Engine instance ID.	optional
cloudType	string	- The element can hold these values `AZURE` `EC2` `GOOGLE_CLOUD_PLATFORM` `OPENSTACK` `ORACLE` `UNRECOGNIZED`	optional
agentVersion	AgentVersion	Defines the version of the agent currently running on the entity.	optional
awsSecurityGroup	string[]	-	optional
paasMemoryLimit	integer	-	optional
amiId	string	-	optional
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.	optional
gceInstanceName	string	The Google Compute Engine instance name.	optional
paasType	string	- 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`	optional
azureVmName	string	-	optional
openstackAvZone	string	-	optional
autoScalingGroup	string	-	optional
kubernetesNode	string	The kubernetes node the entity is in.	optional
azureHostNames	string[]	-	optional
azureZone	string	-	optional
esxiHostName	string	-	optional
osArchitecture	string	- The element can hold these values `ARM` `IA64` `PARISC` `PPC` `PPCLE` `S390` `SPARC` `X86` `ZOS`	optional
azureVmSizeLabel	string	-	optional
azureResourceGroupName	string	-	optional
azureSku	string	- The element can hold these values `BASIC` `DYNAMIC` `FREE` `PREMIUM` `SHARED` `STANDARD`	optional
networkZoneId	string	The ID of network zone the entity is in.	optional
openstackProjectName	string	-	optional
zosTotalZiipProcessors	integer	Number of assigned support processors for this LPAR.	optional
kubernetesLabels	object	The kubernetes labels defined on the entity.	optional
gceMachineType	string	The Google Compute Engine machine type.	optional
boshDeploymentId	string	The Cloud Foundry BOSH deployment ID.	optional
zosCPUModelNumber	string	The CPU model number.	optional
simultaneousMultithreading	integer	The AIX instance simultaneous threads count.	optional
azureEnvironment	string	-	optional
oneAgentCustomHostName	string	The custom name defined in OneAgent config.	optional
softwareTechnologies	TechnologyInfo[]	-	optional
ipAddresses	string[]	-	optional
localHostName	string	-	optional
cloudPlatformVendorVersion	string	Defines the cloud platform vendor version.	optional
awsInstanceType	string	-	optional
consumedHostUnits	string	-	optional
isMonitoringCandidate	boolean	-	optional
localIp	string	-	optional
gceProject	string	The Google Compute Engine project.	optional
logicalCpus	integer	The AIX instance logical CPU count.	optional
fromRelationships	object	-	optional

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description Required

context

string

Element	Type	Description	Required
context	string	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`	required
key	string	The key of the tag. Custom tags have the tag value here.	required
value	string	The value of the tag. Not applicable to custom tags.	optional

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

required

key

string

The key of the tag.

Custom tags have the tag value here.

required

value

string

The value of the tag.

Not applicable to custom tags.

optional

The `AgentVersion` object

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

Element	Type	Description	Required
major	integer	The major version number.	optional
minor	integer	The minor version number.	optional
revision	integer	The revision number.	optional
timestamp	string	A timestamp string: format "yyyymmdd-hhmmss	optional
sourceRevision	string	A string representation of the SVN revision number.	optional

The `HostGroup` object

Element	Type	Description	Required
meId	string	The Dynatrace entity ID of the host group.	optional
name	string	The name of the Dynatrace entity, displayed in the UI.	optional

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
id	string	The ID of the Dynatrace entity.	required
name	string	The name of the Dynatrace entity.	optional
description	string	A short description of the Dynatrace entity.	optional

The `TechnologyInfo` object

Element	Type	Description	Required
type	string	-	optional
edition	string	-	optional
version	string	-	optional

Response body JSON model

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

Response headers

Header	Type	Description
Total-Count	integer	The estimated number of results.
Next-Page-Key	string	The cursor for the next page of results. Without it you'll get the first page again.
Page-Size	string	The 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

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

Request URL

http
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

Hosts API - GET all hosts

Authentication

Parameters

Response

Response codes

Response body objects

The Host object

The TagInfo object

The AgentVersion object

The HostGroup object

The EntityShortRepresentation object

The TechnologyInfo object

Response body JSON model

Response headers

Example

Curl

Request URL

Response body

Response code

The `Host` object

The `TagInfo` object

The `AgentVersion` object

The `HostGroup` object

The `EntityShortRepresentation` object

The `TechnologyInfo` object