Skip Navigation

Get device by hostname

Request device resources belonging to a tenant by using the hostname (DNS name).
The hostname ("host_name") may not be the same as the name ("name") displayed by
BlackBerry
. The hostname is created by the operating system, while the name can be changed in the
Cylance
console or API. For domain-joined computers, the "host_name" would be "hostname.domain.com". For computers not joined to a domain, it would just be "hostname".
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

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
agent_version
This is the
BlackBerry 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
This is the date and time (in UTC) when the device record was created.
date_last_modified
This is the date and time (in UTC) when the device record was last modified.
date_offline
This is the date and time (in UTC) when the device last communicated with the console.
days_to_deletion
This is the number of days before a device will be deleted. Enable automated device lifecycle management and remove inactive devices must both be enabled under device management. If enable automated lifecycle management is enabled and remove inactive devices is disabled, this field displays Unknown.
distinguished_name
This is the unique identifier for the device in the Lightweight Directory Access Protocol (LDAP).
dlcm_status
This is the device lifecycle management status of the device, which shows the device as included or excluded from device lifecycle management. If device lifecycle management is disabled, the status shows as unknown.
host_name
This is the hostname for the device.
id
This is the unique identifier for the device.
ip_addresses
This is the list of IP addresses for the device.
is_safe
If this is true, there are no outstanding threats.
last_logged_in_user
This is the ID of the user who logged in last on to the device.
mac_addresses
This is the list of MAC addresses for the device.
name
This is the name of the device.
os_kernel_version
This is the Kernel version for the operating system on the device.
os_version
This is the operating system and version.
policy
This is the name of the policy assigned to the device.
products
This is 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
This is the update phase on which the device is scheduled.