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}

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 format

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
amiId string
paasAgentVersions AgentVersion[]

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

localHostName string
zosTotalZiipProcessors integer

Number of assigned support processors for this LPAR.

zosTotalGeneralPurposeProcessors integer

Number of assigned processors for this LPAR.

oneAgentCustomHostName string

The custom name defined in OneAgent config.

boshInstanceId string

The Cloud Foundry BOSH instance ID.

gceProject string

The Google Compute Engine project.

boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.

kubernetesNode string

The kubernetes node the entity is in.

azureComputeModeName string The azureComputeModeName element can hold these values.
kubernetesLabels object

The kubernetes labels defined on the entity.

simultaneousMultithreading integer

The AIX instance simultaneous threads count.

azureHostNames string[]
cpuCores integer
cloudType string The cloudType element can hold these values.
openstackProjectName string
monitoringMode string The monitoringMode element can hold these values.
zosTotalPhysicalMemory integer

Memory assigned to the host (Terabyte).

logicalCpuCores integer
azureSku string The azureSku element can hold these values.
gceMachineType string

The Google Compute Engine machine type.

zosCPUSerialNumber string

The CPU serial number.

osVersion string
boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.

azureVmName string
osType string The osType element can hold these values.
boshName string

The Cloud Foundry BOSH name.

openstackSecurityGroups string[]
esxiHostName string
gcpZone string

The Google Cloud Platform Zone.

boshInstanceName string

The Cloud Foundry BOSH instance name.

openStackInstaceType string
agentVersion AgentVersion
publicHostName string
bitness string The bitness element can hold these values.
virtualCpus integer

The AIX instance virtual CPU count.

osArchitecture string The osArchitecture element can hold these values.
gceProjectId string

The Google Compute Engine numeric project ID.

paasType string The paasType element can hold these values.
zosCPUModelNumber string

The CPU model number.

gceInstanceName string

The Google Compute Engine instance name.

hypervisorType string The hypervisorType element can hold these values.
vmwareName string
paasMemoryLimit integer
logicalCpus integer

The AIX instance logical CPU count.

boshDeploymentId string

The Cloud Foundry BOSH deployment ID.

zosVirtualization string

Type of virtualization on the mainframe.

openstackAvZone string
networkZoneId string

The ID of network zone the entity is in.

awsInstanceType string
gceInstanceId string

The Google Compute Engine instance ID.

beanstalkEnvironmentName string
openstackComputeNodeName string
softwareTechnologies TechnologyInfo[]
ipAddresses string[]
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

gcePublicIpAddresses string[]

The public IP addresses of the Google Compute Engine.

userLevel string The userLevel element can hold these values.
azureSiteNames string[]
awsSecurityGroup string[]
isMonitoringCandidate boolean
autoScalingGroup string
hostGroup HostGroup
localIp string
scaleSetName string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.

awsNameTag string

The name inherited from AWS.

consumedHostUnits string
openstackVmName string
awsInstanceId string
kubernetesCluster string

The kubernetes cluster the entity is in.

publicIp string
fromRelationships object

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.

The TechnologyInfo object

Element Type Description
type string
edition string
version string

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

The context element can hold these values.
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.

Possible values

Possible values for the userLevel element in the Host object:

  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER

Possible values for the hypervisorType element in the Host object:

  • HYPERV
  • KVM
  • LPAR
  • QEMU
  • VIRTUALBOX
  • VMWARE
  • WPAR
  • XEN

Possible values for the paasType element in the Host object:

  • AWS_ECS_EC2
  • AWS_ECS_FARGATE
  • AWS_LAMBDA
  • AZURE_WEBSITES
  • CLOUD_FOUNDRY
  • GOOGLE_APP_ENGINE
  • HEROKU
  • KUBERNETES
  • OPENSHIFT

Possible values for the osArchitecture element in the Host object:

  • ARM
  • IA64
  • PARISC
  • PPC
  • PPCLE
  • S390
  • SPARC
  • X86
  • ZOS

Possible values for the bitness element in the Host object:

  • 32bit
  • 64bit

Possible values for the osType element in the Host object:

  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS

Possible values for the azureSku element in the Host object:

  • BASIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD

Possible values for the monitoringMode element in the Host object:

  • FULL_STACK
  • INFRASTRUCTURE
  • OFF

Possible values for the cloudType element in the Host object:

  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE

Possible values for the azureComputeModeName element in the Host object:

  • DEDICATED
  • SHARED

Possible values for the context element in the TagInfo object:

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES

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