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?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 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_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.

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.

hostname

The hostname for the device.

id

The endpoint's unique identifier.

ip_addresses

The list of IP addresses for the device.

is_safe

If this is true, there are no outstanding threats.

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.

page_number

The page number requested.

page_size

The page size requested.

policy

The policy ID and name.

products

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

The total number of resources.

total_pages

The total number of pages that can be retrieved, based on the page size specified.