Hosts API - GET a host

We have a new version of this API—Entity API v2. Check it out!

Gets the parameters of the specified host.

The request produces an application/json payload.

GET
  • Managed 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}

Authentication

To execute this request, you need the 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

Parameter Type Description In Required
meIdentifier string

The Dynatrace entity ID of the required host.

path required

Response

Response codes

Code Description
200

Success

Response body

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.

toRelationships object
paasType string
awsSecurityGroup string[]
userLevel string
logicalCpus integer

The AIX instance logical CPU count.

zosCPUSerialNumber string

The CPU serial number.

localHostName string
osType string
scaleSetName string
bitness string
awsNameTag string

The name inherited from AWS.

cpuCores integer
boshInstanceId string

The Cloud Foundry BOSH instance ID.

boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

beanstalkEnvironmentName string
azureSku string
boshInstanceName string

The Cloud Foundry BOSH instance name.

zosTotalGeneralPurposeProcessors integer

Number of assigned processors for this LPAR.

virtualCpus integer

The AIX instance virtual CPU count.

networkZoneId string

The ID of network zone the entity is in.

zosTotalPhysicalMemory integer

Memory assigned to the host (Terabyte).

paasMemoryLimit integer
softwareTechnologies TechnologyInfo[]
zosTotalZiipProcessors integer

Number of assigned support processors for this LPAR.

openstackVmName string
osArchitecture string
oneAgentCustomHostName string

The custom name defined in OneAgent config.

gceProject string

The Google Compute Engine project.

consumedHostUnits string
gcePublicIpAddresses string[]

The public IP addresses of the Google Compute Engine.

osVersion string
openStackInstaceType string
openstackComputeNodeName string
vmwareName string
amiId string
gceProjectId string

The Google Compute Engine numeric project ID.

hostGroup HostGroup
kubernetesCluster string

The kubernetes cluster the entity is in.

monitoringMode string
gceInstanceId string

The Google Compute Engine instance ID.

hypervisorType string
azureComputeModeName string
autoScalingGroup string
logicalCpuCores integer
publicIp string
gcpZone string

The Google Cloud Platform Zone.

ipAddresses string[]
boshName string

The Cloud Foundry BOSH name.

esxiHostName string
isMonitoringCandidate boolean
openstackAvZone string
boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

zosCPUModelNumber string

The CPU model number.

gceMachineType string

The Google Compute Engine machine type.

openstackSecurityGroups string[]
localIp string
awsInstanceType string
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

awsInstanceId string
azureHostNames string[]
azureSiteNames string[]
kubernetesNode string

The kubernetes node the entity is in.

agentVersion AgentVersion
paasAgentVersions AgentVersion[]

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

gceInstanceName string

The Google Compute Engine instance name.

managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

kubernetesLabels object

The kubernetes labels defined on the entity.

cloudType string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

zosVirtualization string

Type of virtualization on the mainframe.

publicHostName string
azureVmName string
openstackProjectName string
fromRelationships object

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.

timestamp string

A timestamp string: format "yyyymmdd-hhmmss

sourceRevision string

A string representation of the SVN revision number.

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 TechnologyInfo object

Element Type Description
type string
edition 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.

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.

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

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

Request URL

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

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

Response code

200