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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{meIdentifier} |
Environment ActiveGate | https://{your-activegate-domain}:9999/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
The Dynatrace entity ID of the required host.
Response
Response codes
Response body objects
The Host
object
Information about the host.
Status of auto-injection
DISABLED_MANUALLY
DISABLED_ON_INSTALLATION
DISABLED_ON_SANITY_CHECK
ENABLED
FAILED_ON_INSTALLATION
The name inherited from AWS.
DEDICATED
SHARED
BASIC
DYNAMIC
FREE
PREMIUM
SHARED
STANDARD
32bit
64bit
The Cloud Foundry BOSH availability zone.
The Cloud Foundry BOSH deployment ID.
The Cloud Foundry BOSH instance ID.
The Cloud Foundry BOSH instance name.
The Cloud Foundry BOSH name.
The Cloud Foundry BOSH stemcell version.
Defines the cloud platform vendor version.
AZURE
EC2
GOOGLE_CLOUD_PLATFORM
OPENSTACK
ORACLE
UNRECOGNIZED
The customized name of the entity
The discovered name of the entity
The name of the Dynatrace entity as displayed in the UI.
The Dynatrace entity ID of the required entity.
The timestamp of when the entity was first detected, in UTC milliseconds
The Google Compute Engine instance ID.
The Google Compute Engine instance name.
The Google Compute Engine machine type.
The Google Compute Engine project.
The Google Compute Engine numeric project ID.
The public IP addresses of the Google Compute Engine.
The Google Cloud Platform Zone.
AHV
AWS_NITRO
GVISOR
HYPERV
KVM
LPAR
QEMU
UNRECOGNIZED
VIRTUALBOX
VMWARE
WPAR
XEN
The kubernetes cluster the entity is in.
The kubernetes labels defined on the entity.
The kubernetes node the entity is in.
The timestamp of when the entity was last detected, in UTC milliseconds
The AIX instance logical CPU count.
FULL_STACK
INFRASTRUCTURE
OFF
The ID of network zone the entity is in.
The custom name defined in OneAgent config.
ARM
IA64
PARISC
PPC
PPCLE
S390
SPARC
X86
ZOS
AIX
DARWIN
HPUX
LINUX
SOLARIS
WINDOWS
ZOS
AWS_ECS_EC2
AWS_ECS_FARGATE
AWS_LAMBDA
AZURE_FUNCTIONS
AZURE_WEBSITES
CLOUD_FOUNDRY
GOOGLE_APP_ENGINE
GOOGLE_CLOUD_RUN
HEROKU
KUBERNETES
OPENSHIFT
The AIX instance simultaneous threads count.
NON_SUPERUSER
NON_SUPERUSER_STRICT
SUPERUSER
The AIX instance virtual CPU count.
The CPU model number.
The CPU serial number.
Name of the LPAR.
Name of the system.
Number of assigned processors for this LPAR.
Memory assigned to the host (Terabyte).
Number of assigned support processors for this LPAR.
Type of virtualization on the mainframe.
The AgentVersion
object
Defines the version of the agent currently running on the entity.
The major version number.
The minor version number.
The revision number.
A string representation of the SVN revision number.
A timestamp string: format "yyyymmdd-hhmmss
The HostGroup
object
The Dynatrace entity ID of the host group.
The name of the Dynatrace entity, displayed in the UI.
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
The TechnologyInfo
object
The TagInfo
object
Tag of a Dynatrace entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS
value.
AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES
The key of the tag.
Custom tags have the tag value here.
The value of the tag.
Not applicable to custom tags.
Response body JSON model
{"agentVersion": {"major": 1,"minor": 1,"revision": 1,"sourceRevision": "string","timestamp": "string"},"amiId": "string","autoInjection": "DISABLED_MANUALLY","autoScalingGroup": "string","awsInstanceId": "string","awsInstanceType": "string","awsNameTag": "string","awsSecurityGroup": ["string"],"azureComputeModeName": "DEDICATED","azureEnvironment": "string","azureHostNames": ["string"],"azureResourceGroupName": "string","azureResourceId": "string","azureSiteNames": ["string"],"azureSku": "BASIC","azureVmName": "string","azureVmScaleSetName": "string","azureVmSizeLabel": "string","azureZone": "string","beanstalkEnvironmentName": "string","bitness": "32bit","boshAvailabilityZone": "string","boshDeploymentId": "string","boshInstanceId": "string","boshInstanceName": "string","boshName": "string","boshStemcellVersion": "string","cloudPlatformVendorVersion": "string","cloudType": "AZURE","consumedHostUnits": "string","cpuCores": 1,"customizedName": "string","discoveredName": "string","displayName": "string","entityId": "string","esxiHostName": "string","firstSeenTimestamp": 1,"fromRelationships": {"isNetworkClientOfHost": ["string"]},"gceInstanceId": "string","gceInstanceName": "string","gceMachineType": "string","gceProject": "string","gceProjectId": "string","gcePublicIpAddresses": ["string"],"gcpZone": "string","hostGroup": {"meId": "string","name": "string"},"hypervisorType": "AHV","ipAddresses": ["string"],"isMonitoringCandidate": true,"kubernetesCluster": "string","kubernetesLabels": {},"kubernetesNode": "string","lastSeenTimestamp": 1,"localHostName": "string","localIp": "string","logicalCpuCores": 1,"logicalCpus": 1,"managementZones": [{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}],"monitoringMode": "FULL_STACK","networkZoneId": "string","oneAgentCustomHostName": "string","openStackInstaceType": "string","openstackAvZone": "string","openstackComputeNodeName": "string","openstackProjectName": "string","openstackSecurityGroups": ["string"],"openstackVmName": "string","osArchitecture": "ARM","osType": "AIX","osVersion": "string","paasAgentVersions": [{}],"paasMemoryLimit": 1,"paasType": "AWS_ECS_EC2","publicHostName": "string","publicIp": "string","scaleSetName": "string","simultaneousMultithreading": 1,"softwareTechnologies": [{"edition": "string","type": "string","version": "string"}],"tags": [{"context": "AWS","key": "string","value": "string"}],"toRelationships": {"isNetworkClientOfHost": ["string"],"isProcessOf": ["string"],"isSiteOf": ["string"],"runsOn": ["string"]},"userLevel": "NON_SUPERUSER","virtualCpus": 1,"vmwareName": "string","zosCPUModelNumber": "string","zosCPUSerialNumber": "string","zosLpaName": "string","zosSystemName": "string","zosTotalGeneralPurposeProcessors": 1,"zosTotalPhysicalMemory": 1,"zosTotalZiipProcessors": 1,"zosVirtualization": "string"}
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 dt0c01.abc123.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