Get device by hostname

Use the hostname (DNS name) to request device resources belonging to a tenant. Because the OS creates the host_name while users can modify the name displayed in Aurora Endpoint Security console, the host_name and name values might not match. For domain-joined computers, the host_name value is in the format host_name.domain.com. For computers not joined to a domain, the host_name value is just host_name.

Service endpoint

/devices/v2/hostname/{host_name}

Optional query string parameters

—

Example

https://protectapi.cylance.com/devices/v2/hostname/User-Laptop-A123

Method

HTTP/1.1 GET

Request headers
  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the device:read scope encoded

Request

None

Response

For more information, see Response status codes.

Response JSON schema

Field Name Description

agent_version

The Aurora Protect Desktop agent version installed on the device.

background_detection

If this is true, the agent is currently running a background threat detection scan.

date_first_registered

The date and time when the device record was created, in UTC.

date_last_modified

The date and time when the device record was last modified, in UTC.

date_offline

The date and time when the device last communicated with the console, in UTC.

days_to_deletion

The number of days before a device is deleted.

Note:

This field only displays data if you enabled both Enable automated device lifecycle management and Remove inactive devices under Settings > Device Lifecycle in the Aurora Endpoint Security console. If you enabled Enable automated device lifecycle management but not Remove inactive devices, this field displays Unknown.

distinguished_name

The unique identifier for the device in the Lightweight Directory Access Protocol (LDAP).

dlcm_status

The device lifecycle management status, showing the device as included or excluded from device lifecycle management. If device lifecycle management is disabled, the status shows as Unknown.

host_name

The hostname for the device.

id

The unique identifier for the device.

ip_addresses

The list of IP addresses for the device.

is_safe

If this is true, there are no outstanding threats.

last_logged_in_user

The ID of the user who logged in last on to the device.

mac_addresses

The list of MAC addresses for the device.

name

The name of the device.

os_kernel_version

The Kernel version for the operating system on the device.

os_version

The operating system and version.

policy

The name of the policy assigned to the device.

products

The name of the product installed on the device, the version number, and status. The version number is major, minor, and build number to match the data displayed in the console.

state

State of the device (for example, online or offline). If device lifecycle management is enabled, the state could be inactive.

update_available

If this is true, an agent update is available for the device based on the update type (phase).

update_type

The update phase on which the device is scheduled.