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

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 element can hold these values `min` `5mins` `10mins` `15mins` `30mins` `hour` `2hours` `6hours` `day` `3days`	query	optional
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	optional
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	optional
entity	string[]	Filters result to the specified hosts only. To specify several hosts use the following format: `entity=ID1&entity=ID2`.	query	optional
managementZone	integer	Only return hosts that are part of the specified management zone.	query	optional
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	optional
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	optional
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	optional
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	optional
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	optional

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

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description

context

string

Element	Type	Description
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`
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. Can be `null`.

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

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.

Can be null.

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element Type Description

string

Element	Type	Description
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity. Can be `null`.
description	string	A short description of the Dynatrace entity. Can be `null`.

The ID of the Dynatrace entity.

name

string

The name of the Dynatrace entity.

Can be null.

description

string

A short description of the Dynatrace entity.

Can be null.

The `AgentVersion` object

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

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

The `HostGroup` object

Element Type Description

meId

string

Element	Type	Description
meId	string	The Dynatrace entity ID of the host group. Can be `null`.
name	string	The name of the Dynatrace entity, displayed in the UI. Can be `null`.

The Dynatrace entity ID of the host group.

Can be null.

name

string

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

Can be null.

The `TechnologyInfo` object

Element	Type	Description
type	string	- Can be `null`.
edition	string	- Can be `null`.
version	string	- 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

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

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

Hosts API - GET all hosts

Authentication

Parameters

Response

Response codes

Response body objects

The Host object

The TagInfo object

The EntityShortRepresentation object

The AgentVersion object

The HostGroup 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 `EntityShortRepresentation` object

The `AgentVersion` object

The `HostGroup` object

The `TechnologyInfo` object