Skip Navigation
  1. BlackBerry Docs
  2. Cylance Endpoint Security
  3. Cylance User API guide
  4. Device API
  5. Get devices

Get devices

Request a page with a list of device resources belonging to a tenant. The page number and page size parameters are optional. When the values are not specified, these default to 1 and 100 respectively. The maximum page size that can be specified is 10000 entries per page.
Service Endpoint
/devices/v2?page=m&page_size=n
Optional query string parameters
  • page: This is the page number to request.
  • page_size: This is the number of device records to retrieve per page.
Example
Return the first page with 100 devices: https://protectapi.cylance.com/devices/v2?page=1&page_size=100
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
     with the device:list scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
created
This is the date and time (in UTC) when the device record was created.
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.
deviceCarrier
This is the name of the device's service provider (for example,  AT&T or Verizon).
deviceType
This is the the type of device (for example, desktop or mobile).
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.
id
This is the unique identifier of the endpoint.
ipAddresses
This is the list of IP addresses for the device.
macAddresses
This is the list of MAC addresses for the device.
modelOfDevice
This is the device model (for example,
iPhone
 or Pixel 3 XL).
name
This is the name of the device.
osDescription
This is the operating system running on the device (for example,
Windows
 10 or
iOS
 12.3.1).
quarantinedThreatCount
This is the total number of quarantined threats for the device.
safeStatus
This is the status of the device (for example, safe or risk).
unresolvedThreatCount
This is the total number of unresolved threats on the device.