Get Devices v3.5

API version	3.5
Last Update	07/19/2022
Authentication	YES
HTTP Method	POST
Content Type	application/json
Rate limited	YES
Requests per rate limit	10/min
Response Format	JSON
Changes	Changes compare with v3.4 Added in_grace_period field into the API response.

Receiving devices in the cursor fashion, with ascending order of enrolling time.

API URL

Request Parameters

Key	Datatype	Parameter Type	Required	Description	Default
access_token	string	URL	Yes	access token which archived from OAuth authentication step
token	string	Body	Optional	Specify a pagination token that devices will be returned in. It can be used to return the next set of items in the list. Return the oldest items in case the token is missing.
limit	int	Body	Optional	Specify maximum number of devices will be returned in the response. The value should be in [1,50].	20

Notes:

criteria in a same parameter will be combined with OR operator
criteria in different parameter will be combined with AND operator

Response HTTP Code

See APIs

Response Parameters

Key	DataType	Description
next_token	string	A pagination token.
devices	Array Object	The returned devices.
devices.device_id	string	HWID of a device
devices.severity	string	Issue severity of the device Values can be: "critical", "warning", "no_issues"
devices.enrolled_at	string	Timestamp in GMT format when a device enrolled to an account
devices.status	string	device status Values can be: "compliant", "non_compliant", "exempted", "out_of_license_usage", "unknown", "ignored", "installed", "pending", "quarantined"
devices.device_name	string	device name
devices.nickname	string	device nickname (editable on the cloud console)
devices.device_type	string	device type Values can be "desktop","laptop","phone","tablet","server","vm"
devices.last_seen	string	The last timestamp in GMT format when an agent reports its data to Cloud
devices.last_reboot	string	The last timestamp in GMT format when the device reboots
devices.agent_version	string	agent version
devices.remediation_link	string	URL of remediation page for the given device
devices.group_name	string	Group name which a device is assigned to
devices.issue	object	Summary of issues a device has
devices.issue.total_issue	int	number of issues a device has
devices.issue.total_critical	int	number of critical issues a device has
devices.issue.total_warning	int	number of warning issues a device has
devices.geo_info	object	Location details of the device where the device was in the last report
devices.geo_info.country	string	country of the device where the device was in the last report
devices.network_info	array<object>	Network adapter information block
devices.network_info.mac	string	MAC address of a network adapter
devices.network_info.ipv4	string	IPV4 address of a network adapter
devices.os_info	array<object>	Operation system block
devices.os_info.family	string	OS family
devices.os_info.name	string	OS name
devices.os_info.vendor	string	OS vendor
devices.os_info.version	string	OS version
devices.os_info.type	string	OS type. Values can be: "windows","mac", "linux", "ios", "android"
devices.cves	object	Summary of CVEs a device has
devices.cves.total	int	Total number of CVEs in device
devices.link_user	object	Linked user details
devices.link_user.username	string	Username
devices.link_user.group	string	group which the user is associated to
devices.user_info	object	User information block
devices.user_info.username	string	Currently logged in username
devices.user_info.domain	string	Currently logged in user domain
device.in___grace_period	int	Grace-period status of the device: 0: Device is not in grace period 1: Device is in grace period

Example

Example Request

Example Response

History

Version	URL
v3.3	Get Devices v3.3
v3.2	Get Devices v3.2
v3.1	Get Devices v3.1
v3.0	Get Devices v3.0
v2.3	Get Devices v2.3
v2.2	Get Devices v2.2
v2.1	Get Devices v2.1
v2.1	Search Devices v2.1

Last updated on

Was this page helpful?