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

Get devices extended

Request a page with a list of console devices with extended information, belonging to a tenant, sorted by registration (created) date, in descending order (most recent device registered listed first). 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 200 entries per page.
Service endpoint
/devices/v2/extended?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/extended?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
agent_version
This is the
CylancePROTECT 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_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.
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.
hostname
This is the hostname for the device.
id
This is the endpoint's unique identifier.
ip_addresses
This is the list of IP addresses for the device.
is_safe
If this is true, there are no outstanding threats.
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.
page_number
This is the page number requested.
page_size
This is the page size requested.
policy
This is the policy ID and name.
products
This is the name of the product installed on the device, the version number, and status.
state
This signals whether the device is online or offline. If device lifecycle management is enabled, the state could be inactive.
total_number_of_items
This is the otal number of resources.
total_pages
This is the otal number of pages that can be retrieved, based on the page size specified.