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.dexp.ae/api/v1/entity/infrastructure/hosts/{meIdentifier}

Parameters

Parameter Type Description In Required
meIdentifier string

The DESK entity ID of the required host.

 path required

Response format

The Host object

Element Type Description
entityId string

The DESK entity ID of the required entity.
displayName string

The name of the DESK 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
logicalCpus integer

The AIX instance logical CPU count.
beanstalkEnvironmentName string
boshAvailabilityZone string

The Cloud Foundry BOSH availability zone.
gceProjectId string

The Google Compute Engine numeric project ID.
consumedHostUnits string
azureSiteNames string[]
virtualCpus integer

The AIX instance virtual CPU count.
azureHostNames string[]
gceInstanceId string

The Google Compute Engine instance ID.
gceInstanceName string

The Google Compute Engine instance name.
gcePublicIpAddresses InetAddress[]

The public IP addresses of the Google Compute Engine.
openstackProjectName string
autoScalingGroup string
cloudPlatformVendorVersion string

Defines the cloud platform vendor version.
awsInstanceId string
azureVmName string
isMonitoringCandidate boolean
cpuCores integer
openstackSecurityGroups string[]
openstackVmName string
publicIp string
gcpZone string

The Google Cloud Platform Zone.
boshDeploymentId string

The Cloud Foundry BOSH deployment ID.
hostGroup HostGroup

The host group the entity is in.
osArchitecture string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.
paasMemoryLimit integer
cloudType string
azureSku string
openstackAvZone string
logicalCpuCores integer
kubernetesNode string

The kubernetes node the entity is in.
localHostName string
openStackInstaceType string
hypervisorType string
softwareTechnologies TechnologyInfo[]
esxiHostName string
ipAddresses string[]
monitoringMode string
scaleSetName string
osType string
awsSecurityGroup string[]
simultaneousMultithreading integer

The AIX instance simultaneous threads count.
gceMachineType string

The Google Compute Engine machine type.
awsNameTag string

The name inherited from AWS.
bitness string
osVersion string
userLevel string
azureComputeModeName string
boshName string

The Cloud Foundry BOSH name.
paasType string
publicHostName string
agentVersion AgentVersion

The version of OneAgent currently running on the entity.

This is currently not supported for PaaS Agents.
boshInstanceId string

The Cloud Foundry BOSH instance ID.
localIp string
awsInstanceType string
kubernetesCluster string

The kubernetes cluster the entity is in.
gceProject string

The Google Compute Engine project.
amiId string
openstackComputeNodeName string
kubernetesLabels object

The kubernetes labels defined on the entity.
boshStemcellVersion string

The Cloud Foundry BOSH stemcell version.
vmwareName string
boshInstanceName string

The Cloud Foundry BOSH instance name.
oneAgentCustomHostName string

The custom name defined in OneAgent config.

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

Element Type Description
type string
edition string
version string

The EntityShortRepresentation object

The short representation of a DESK entity.

Element Type Description
id string

The ID of the DESK entity.
name string

The name of the DESK entity.
description string

A short description of the DESK entity.

The HostGroup object

Element Type Description
meId string

The DESK entity ID of the host group.
name string

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

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

Tag of a DESK 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.dexp.ae/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5 \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/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