Hosts API - GET a host

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 parameters of the specified host.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{meIdentifier}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}`

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

Parameter	Type	Description	In	Required
meIdentifier	string	The Dynatrace entity ID of the required host.	path	required

Response

Response codes

Code	Type	Description
200	Host	Success

Response body objects

The `Host` object

Information about the host.

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

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.

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.

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.
timestamp	string	A timestamp string: format "yyyymmdd-hhmmss
sourceRevision	string	A string representation of the SVN revision number.

The `TechnologyInfo` object

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

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

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

Example

In this example, the request queries the parameters of the tag009 host, which has the ID of HOST-B7A6F9EE9F366CB5.

The API token is passed in the Authorization header.

Curl

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

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5

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"
    }
  ]
}

Response code

200

Hosts API - GET a host

Authentication

Parameters

Response

Response codes

Response body objects

The Host object

The TagInfo object

The AgentVersion object

The TechnologyInfo object

The HostGroup object

The EntityShortRepresentation object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `Host` object

The `TagInfo` object

The `AgentVersion` object

The `TechnologyInfo` object

The `HostGroup` object

The `EntityShortRepresentation` object