Hosts API - GET all hosts

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.

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

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 relativeTime element can hold these values.
query optional
tag array

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 following format: [context]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 array

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

Possible values

Possible values for the relativeTime element:

  • min
  • 5mins
  • 10mins
  • 15mins
  • 30mins
  • hour
  • 2hours
  • 6hours
  • day
  • 3days

Response format

The Host object

Element Type Description
entityId string

The Dynatrace entity ID of the required entity.

displayName string

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

customizedName string

The customized name of the entity

discoveredName string

The discovered name of the entity

firstSeenTimestamp integer

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

lastSeenTimestamp integer

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

tags TagInfo[]

The list of entity tags.

fromRelationships object
toRelationships object
awsSecurityGroup string[]
bitness string
azureVmName string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

hostGroup HostGroup

The host group the entity is in.

azureSiteNames string[]
azureHostNames string[]
openstackComputeNodeName string
oneAgentCustomHostName string

The custom name defined in OneAgent config.

localIp string
amiId string
openstackAvZone string
openStackInstaceType string
logicalCpuCores integer
gceMachineType string

The Google Compute Engine machine type.

boshInstanceName string

The Cloud Foundry BOSH instance name.

publicHostName string
ipAddresses string[]
gceInstanceName string

The Google Compute Engine instance name.

localHostName string
paasAgentVersions AgentVersion[]

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

monitoringMode string
boshName string

The Cloud Foundry BOSH name.

kubernetesLabels object

The kubernetes labels defined on the entity.

kubernetesNode string

The kubernetes node the entity is in.

boshInstanceId string

The Cloud Foundry BOSH instance ID.

osArchitecture string
gceInstanceId string

The Google Compute Engine instance ID.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

gcePublicIpAddresses InetAddress[]

The public IP addresses of the Google Compute Engine.

osVersion string
cpuCores integer
gceProjectId string

The Google Compute Engine numeric project ID.

cloudType string
azureSku string
gcpZone string

The Google Cloud Platform Zone.

vmwareName string
publicIp string
scaleSetName string
logicalCpus integer

The AIX instance logical CPU count.

beanstalkEnvironmentName string
autoScalingGroup string
boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

awsInstanceId string
awsNameTag string

The name inherited from AWS.

userLevel string
esxiHostName string
azureComputeModeName string
softwareTechnologies TechnologyInfo[]
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

awsInstanceType string
openstackVmName string
isMonitoringCandidate boolean
agentVersion AgentVersion

The version of OneAgent currently running on the entity.

hypervisorType string
virtualCpus integer

The AIX instance virtual CPU count.

gceProject string

The Google Compute Engine project.

paasType string
openstackProjectName string
osType string
openstackSecurityGroups string[]
kubernetesCluster string

The kubernetes cluster the entity is in.

paasMemoryLimit integer
boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

consumedHostUnits string

The TechnologyInfo object

Element Type Description
type string
edition string
version string

The InetAddress object

Element Type Description
canonicalHostName string
multicastAddress boolean
anyLocalAddress boolean
loopbackAddress boolean
linkLocalAddress boolean
siteLocalAddress boolean
mcglobal boolean
mcnodeLocal boolean
mclinkLocal boolean
mcsiteLocal boolean
mcorgLocal boolean
address string[]
hostAddress string
hostName string

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

The AgentVersion object

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

Element Type Description
major integer

The major version number.

minor integer

The minor version number.

revision integer

The revision number.

sourceRevision string

A string representation of the SVN revision number.

timestamp string

A timestamp string: format "yyyymmdd-hhmmss

The HostGroup object

Element Type Description
meId string

The Dynatrace entity ID of the host group.

name string

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

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description
context string

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

Custom tags use the CONTEXTLESS value.

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.

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

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

Request URL

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

Response body

[
  {
    "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