Hosts API - GET a host

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}

Parameters

Parameter Type Description In Required
meIdentifier string

The Dynatrace entity ID of the required host.

path required

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
cloudType string
consumedHostUnits string
vmwareName string
hostGroup HostGroup

The host group the entity is in.

logicalCpuCores integer
networkZoneId string

The ID of network zone the entity is in.

openstackSecurityGroups string[]
virtualCpus integer

The AIX instance virtual CPU count.

gceProjectId string

The Google Compute Engine numeric project ID.

zosCPUSerialNumber string

The CPU serial number.

boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

paasType string
kubernetesCluster string

The kubernetes cluster the entity is in.

monitoringMode string
paasAgentVersions AgentVersion[]

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

zosTotalPhysicalMemory integer

Memory assigned to the host (Terabyte).

publicIp string
gceInstanceName string

The Google Compute Engine instance name.

gceMachineType string

The Google Compute Engine machine type.

osVersion string
esxiHostName string
boshName string

The Cloud Foundry BOSH name.

ipAddresses string[]
openStackInstaceType string
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

publicHostName string
cpuCores integer
zosCPUModelNumber string

The CPU model number.

scaleSetName string
zosTotalZiipProcessors integer

Number of assigned support processors for this LPAR.

awsNameTag string

The name inherited from AWS.

azureSiteNames string[]
hypervisorType string
gcpZone string

The Google Cloud Platform Zone.

logicalCpus integer

The AIX instance logical CPU count.

awsInstanceId string
isMonitoringCandidate boolean
boshInstanceId string

The Cloud Foundry BOSH instance ID.

awsInstanceType string
openstackProjectName string
osArchitecture string
paasMemoryLimit integer
beanstalkEnvironmentName string
kubernetesNode string

The kubernetes node the entity is in.

oneAgentCustomHostName string

The custom name defined in OneAgent config.

kubernetesLabels object

The kubernetes labels defined on the entity.

zosTotalGeneralPurposeProcessors integer

Number of assigned processors for this LPAR.

gcePublicIpAddresses InetAddress[]

The public IP addresses of the Google Compute Engine.

localIp string
gceProject string

The Google Compute Engine project.

openstackVmName string
simultaneousMultithreading integer

The AIX instance simultaneous threads count.

agentVersion AgentVersion

The version of OneAgent currently running on the entity.

amiId string
openstackComputeNodeName string
boshInstanceName string

The Cloud Foundry BOSH instance name.

zosVirtualization string

Type of virtualization on the mainframe.

gceInstanceId string

The Google Compute Engine instance ID.

azureSku string
localHostName string
autoScalingGroup string
openstackAvZone string
azureVmName string
boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

azureHostNames string[]
bitness string
azureComputeModeName string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

userLevel string
osType string
softwareTechnologies TechnologyInfo[]
awsSecurityGroup 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.

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