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 10,000 entries per page.

Service Endpoint

/devices/v2?page=m&page_size=n

Optional query string parameters
  • page: The page number to request.
  • page_size: 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

For more information, see the Response status codes.

Response JSON schema

Field Name Description

created

The date and time when the device record was created, 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.

deviceCarrier

The name of the device service provider, such as AT&T or Verizon.

deviceType

The type of device, such as desktop or mobile.

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.

id

The unique identifier of the endpoint.

ipAddresses

The list of IP addresses for the device.

macAddresses

The list of MAC addresses for the device.

modelOfDevice

The device model, such as iPhone or Pixel 3 XL.

name

The name of the device.

osDescription

The operating system running on the device, such as Windows 10 or iOS 12.3.1.

quarantinedThreatCount

The total number of quarantined threats for the device.

safeStatus

The device status, such as safe or risk.

unresolvedThreatCount

The total number of unresolved threats on the device.