• Home
  • Dynatrace API
  • Environment
  • Topology and Smartscape v1
  • Hosts
  • GET a host

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{meIdentifier}
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
meIdentifierstring

The Dynatrace entity ID of the required host.

pathrequired

Response

Response codes

CodeTypeDescription
200Host

Success

Response body objects

The Host object

Information about the host.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the required entity.

displayNamestring

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

customizedNamestring

The customized name of the entity

discoveredNamestring

The discovered name of the entity

firstSeenTimestampinteger

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

lastSeenTimestampinteger

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

tagsTagInfo[]

The list of entity tags.

fromRelationshipsobject-
toRelationshipsobject-
networkZoneIdstring

The ID of network zone the entity is in.

kubernetesLabelsobject

The kubernetes labels defined on the entity.

gcePublicIpAddressesstring[]

The public IP addresses of the Google Compute Engine.

gceProjectIdstring

The Google Compute Engine numeric project ID.

zosCPUModelNumberstring

The CPU model number.

azureVmScaleSetNamestring-
boshNamestring

The Cloud Foundry BOSH name.

cloudPlatformVendorVersionstring

Defines the cloud platform vendor version.

zosLpaNamestring

Name of the LPAR.

azureVmSizeLabelstring-
paasAgentVersionsAgentVersion[]

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

openstackSecurityGroupsstring[]-
gceInstanceNamestring

The Google Compute Engine instance name.

userLevelstring-
The element can hold these values
  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER
gceInstanceIdstring

The Google Compute Engine instance ID.

publicHostNamestring-
awsNameTagstring

The name inherited from AWS.

gceProjectstring

The Google Compute Engine project.

cloudTypestring-
The element can hold these values
  • AZURE
  • EC2
  • GOOGLE_CLOUD_PLATFORM
  • OPENSTACK
  • ORACLE
  • UNRECOGNIZED
zosTotalGeneralPurposeProcessorsinteger

Number of assigned processors for this LPAR.

boshStemcellVersionstring

The Cloud Foundry BOSH stemcell version.

beanstalkEnvironmentNamestring-
kubernetesClusterstring

The kubernetes cluster the entity is in.

logicalCpuCoresinteger-
boshDeploymentIdstring

The Cloud Foundry BOSH deployment ID.

zosTotalPhysicalMemoryinteger

Memory assigned to the host (Terabyte).

monitoringModestring-
The element can hold these values
  • FULL_STACK
  • INFRASTRUCTURE
  • OFF
localIpstring-
gcpZonestring

The Google Cloud Platform Zone.

hypervisorTypestring-
The element can hold these values
  • AHV
  • AWS_NITRO
  • GVISOR
  • HYPERV
  • KVM
  • LPAR
  • QEMU
  • UNRECOGNIZED
  • VIRTUALBOX
  • VMWARE
  • WPAR
  • XEN
oneAgentCustomHostNamestring

The custom name defined in OneAgent config.

autoScalingGroupstring-
esxiHostNamestring-
paasMemoryLimitinteger-
awsInstanceIdstring-
cpuCoresinteger-
azureComputeModeNamestring-
The element can hold these values
  • DEDICATED
  • SHARED
zosCPUSerialNumberstring

The CPU serial number.

vmwareNamestring-
consumedHostUnitsstring-
localHostNamestring-
kubernetesNodestring

The kubernetes node the entity is in.

openstackComputeNodeNamestring-
boshInstanceIdstring

The Cloud Foundry BOSH instance ID.

paasTypestring-
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
boshInstanceNamestring

The Cloud Foundry BOSH instance name.

azureVmNamestring-
osTypestring-
The element can hold these values
  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS
openstackAvZonestring-
osArchitecturestring-
The element can hold these values
  • ARM
  • IA64
  • PARISC
  • PPC
  • PPCLE
  • S390
  • SPARC
  • X86
  • ZOS
zosVirtualizationstring

Type of virtualization on the mainframe.

azureSiteNamesstring[]-
boshAvailabilityZonestring

The Cloud Foundry BOSH availability zone.

openstackVmNamestring-
awsSecurityGroupstring[]-
autoInjectionstring

Status of auto-injection

The element can hold these values
  • DISABLED_MANUALLY
  • DISABLED_ON_INSTALLATION
  • DISABLED_ON_SANITY_CHECK
  • ENABLED
  • FAILED_ON_INSTALLATION
logicalCpusinteger

The AIX instance logical CPU count.

zosTotalZiipProcessorsinteger

Number of assigned support processors for this LPAR.

osVersionstring-
azureResourceIdstring-
virtualCpusinteger

The AIX instance virtual CPU count.

openstackProjectNamestring-
agentVersionAgentVersion

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

azureHostNamesstring[]-
awsInstanceTypestring-
scaleSetNamestring-
azureEnvironmentstring-
softwareTechnologiesTechnologyInfo[]-
azureResourceGroupNamestring-
isMonitoringCandidateboolean-
gceMachineTypestring

The Google Compute Engine machine type.

amiIdstring-
azureZonestring-
simultaneousMultithreadinginteger

The AIX instance simultaneous threads count.

azureSkustring-
The element can hold these values
  • BASIC
  • DYNAMIC
  • FREE
  • PREMIUM
  • SHARED
  • STANDARD
publicIpstring-
zosSystemNamestring

Name of the system.

hostGroupHostGroup-
openStackInstaceTypestring-
bitnessstring-
The element can hold these values
  • 32bit
  • 64bit
ipAddressesstring[]-
managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

The TagInfo object

Tag of a Dynatrace entity.

ElementTypeDescription
contextstring

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
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

The AgentVersion object

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

ElementTypeDescription
majorinteger

The major version number.

minorinteger

The minor version number.

revisioninteger

The revision number.

timestampstring

A timestamp string: format "yyyymmdd-hhmmss

sourceRevisionstring

A string representation of the SVN revision number.

The TechnologyInfo object

ElementTypeDescription
typestring-
editionstring-
versionstring-

The HostGroup object

ElementTypeDescription
meIdstring

The Dynatrace entity ID of the host group.

namestring

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

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

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

Related topics
  • Hosts

    Learn how to get started with host monitoring, understand which measures contribute to host health, how to set up custom host names, and more.