Hosts API - GET all hosts

This API is deprecated. Use the Monitored entities API instead. You can find more information about switching to the new API in the migration guide.

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	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts`
GET	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/infrastructure/hosts`

Authentication

To execute this request, you need an access token with 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

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.

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.

4XX

ErrorEnvelope

Client side error.

5XX

ErrorEnvelope

Server side error.

Response body objects

The `ResponseBody` object

The `Host` object

Information about the host.

Element

Type

Description

agentVersion

AgentVersion

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

amiId

string

autoInjection

string

Status of auto-injection

DISABLED_MANUALLY
DISABLED_ON_INSTALLATION
DISABLED_ON_SANITY_CHECK
ENABLED
FAILED_ON_INSTALLATION

autoScalingGroup

string

awsInstanceId

string

awsInstanceType

string

awsNameTag

string

The name inherited from AWS.

awsSecurityGroup

string[]

azureComputeModeName

string

DEDICATED
SHARED

azureEnvironment

string

azureHostNames

string[]

azureResourceGroupName

string

azureResourceId

string

azureSiteNames

string[]

azureSku

string

BASIC
DYNAMIC
FREE
PREMIUM
SHARED
STANDARD

azureVmName

string

azureVmScaleSetName

string

azureVmSizeLabel

string

azureZone

string

beanstalkEnvironmentName

string

bitness

string

32bit
64bit

boshAvailabilityZone

string

The Cloud Foundry BOSH availability zone.

boshDeploymentId

string

The Cloud Foundry BOSH deployment ID.

boshInstanceId

string

The Cloud Foundry BOSH instance ID.

boshInstanceName

string

The Cloud Foundry BOSH instance name.

boshName

string

The Cloud Foundry BOSH name.

boshStemcellVersion

string

The Cloud Foundry BOSH stemcell version.

cloudPlatformVendorVersion

string

Defines the cloud platform vendor version.

cloudType

string

AZURE
EC2
GOOGLE_CLOUD_PLATFORM
OPENSTACK
ORACLE
UNRECOGNIZED

consumedHostUnits

string

Consumed Host Units. Applicable only for Dynatrace classic licensing

cpuCores

integer

customizedName

string

The customized name of the entity

discoveredName

string

The discovered name of the entity

displayName

string

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

entityId

string

The Dynatrace entity ID of the required entity.

esxiHostName

string

firstSeenTimestamp

integer

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

fromRelationships

object

gceInstanceId

string

The Google Compute Engine instance ID.

gceInstanceName

string

The Google Compute Engine instance name.

gceMachineType

string

The Google Compute Engine machine type.

gceProject

string

The Google Compute Engine project.

gceProjectId

string

The Google Compute Engine numeric project ID.

gcePublicIpAddresses

string[]

The public IP addresses of the Google Compute Engine.

gcpZone

string

The Google Cloud Platform Zone.

hostGroup

HostGroup

hypervisorType

string

AHV
AWS_NITRO
GVISOR
HYPERV
KVM
LPAR
QEMU
UNRECOGNIZED
VIRTUALBOX
VMWARE
WPAR
XEN

ipAddresses

string[]

isMonitoringCandidate

boolean

kubernetesCluster

string

The kubernetes cluster the entity is in.

kubernetesLabels

object

The kubernetes labels defined on the entity.

kubernetesNode

string

The kubernetes node the entity is in.

lastSeenTimestamp

integer

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

localHostName

string

localIp

string

logicalCpuCores

integer

logicalCpus

integer

The AIX instance logical CPU count.

managementZones

EntityShortRepresentation[]

The management zones that the entity is part of.

monitoringMode

string

FULL_STACK
INFRASTRUCTURE
OFF

networkZoneId

string

The ID of network zone the entity is in.

oneAgentCustomHostName

string

The custom name defined in OneAgent config.

openStackInstaceType

string

openstackAvZone

string

openstackComputeNodeName

string

openstackProjectName

string

openstackSecurityGroups

string[]

openstackVmName

string

osArchitecture

string

ARM
IA64
PARISC
PPC
PPCLE
S390
SPARC
X86
ZOS

osType

string

AIX
DARWIN
HPUX
LINUX
SOLARIS
WINDOWS
ZOS

osVersion

string

paasAgentVersions

AgentVersion[]

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

paasMemoryLimit

integer

paasType

string

AWS_ECS_EC2
AWS_ECS_FARGATE
AWS_LAMBDA
AZURE_FUNCTIONS
AZURE_WEBSITES
CLOUD_FOUNDRY
GOOGLE_APP_ENGINE
GOOGLE_CLOUD_RUN
HEROKU
KUBERNETES
OPENSHIFT

publicHostName

string

publicIp

string

scaleSetName

string

simultaneousMultithreading

integer

The AIX instance simultaneous threads count.

softwareTechnologies

TechnologyInfo[]

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

The short representation of a Dynatrace entity.

Element

Type

Description

description

string

A short description of the Dynatrace entity.

string

The ID of the Dynatrace entity.

name

string

The name of the Dynatrace entity.

The `TechnologyInfo` object

Element

Type

Description

edition

string

type

string

version

string

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.

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.

Response body JSON model

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

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts \
  -H 'Authorization: Api-Token dt0c01.abc123.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

Hosts API - GET all hosts

Authentication

Parameters

Response

Response codes

Response body objects

The ResponseBody object

The Host object

The AgentVersion object

The HostGroup object

The EntityShortRepresentation object

The TechnologyInfo object

The TagInfo object

Response body JSON model

Response headers

Example

Curl

Request URL

Response body

Response code

Related topics

The `ResponseBody` object

The `Host` object

The `AgentVersion` object

The `HostGroup` object

The `EntityShortRepresentation` object

The `TechnologyInfo` object

The `TagInfo` object