access_token

string

URL

Yes

access token which archived from OAuth authentication step

filter

object

Body

Optional

Specify filter criteria

filter.device_type

array<string>

Body

Optional

Specify type of device.

Values can be "desktop","laptop","phone","tablet","server","vm"

filter.category

array<string>

Body

Optional

Specify category which device has issues.

Values can be "antiphishing", "antivirus", "backupclient", "hard_disk_encryption", "firewall", "patch_mangement_agent", "instant_messegener", "cleaner_optimizer", "developer_tool", "cloud_storage", "publicfilesharing", "remote_control", "recording_web_meeting", "uninstaller", "toolbars", "media_player", "vpn_client", "unclassified_pua", "system", "hard_drive", "osupdate", "systemsecurity", "threat_antivirus", "threat_metascan", "threat_ip"

filter.severity

array<string>

Body

Optional

Specific issue severity which device has

Values can be: "critical", "warning", "no_issues"

filter.os

array<string>

Body

Optional

Specify OS type.

Values can be: "windows","mac", "linux", "ios", "android"

filter.device_status

array<string>

Body

Optional

Specify device status

Values can be: "compliant", "non_compliant", "exempted", "out_of_license_usage", "unknown", "ignored", "installed", "pending", "quarantined"

filter.agent_status

array<string>

Body

Optional

Specify agent status

Values can be: "connected", "disconnected", "unseen", "out_of_date"

filter.agent_type

array<string>

Body

Optional

Specify agent type

Values can be: "managed", "dc"

filter.group_id

array<string>

Body

Optional

Specify group id which a device is assigned to

Values can be:

sort

object

Body

Optional

Specify how to sort devices in result-set

By default: sort devices by status in DESC order: quarantined, non-compliant, exempted, compliant, pending, out_of_license_usage, unknown, ignored

sort.order

string

Body

Optional

Specify sort order. Values can be:

• asc: sort devices in ascending order.

• desc: sort devices in descending order.

DESC

sort.field

string

Body

Optional

Specify which field will be sorted by

Values can be: status, ip, nickname, user_name, os, last_seen, issues, group_policy

status

search

string

Body

Optional

keyword to search devices.

limit

int

Body

Optional

Specify maximum number of devices will be returned in the response. The value should be in [1,50]. If there are more devices than what the limit asks for, error code will be 406.

1

page

int

Body

Optional

Specify page number which devices will be returned in. If the requested page exceeds the number of pages of devices, error code will be 413. It means that the requested page number is too large, no devices will be returned in this case.

1

verbose

int

Body

Optional

Specify what information you want to see in response

• 0: no issue details in the response

• 1: device issue details are returned in the response (has not supported yet)

0

200

Success

400

Bad request

401

Unauthorized. Your access_token is invalid or expired

404

Not found

406

Too many devices to return

413

Requested page number exceeds limit

415

Unsupported Media Type