Retrieves the list of Computers with pagination (sorting and filtering). Sort by Created Date, Ascending to avoid returning duplicate entries.

get

https://{example.com}/management-api/v2/Computers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Sorts

array of objects

Allow for sorting on multiple properties using "by" and "order".
"Sorts[x].by" specifies the property on which to sort e.g. name.
"Sorts[x].order" specifies the order in which to sort e.g. asc or desc.
The index "x" specifies the order the sorts are applied. The index must start at 0 and each index must be consecutive e.g. 0, 1, 2.
For example Sorts[0].by, Sorts[0].order, Sorts[1].by, Sorts[1].order.
Also supports repeated objects notation (multiple sorts): Sorts={"By":"name","Order":"Asc"}&Sorts={"By":"created","Order":"Desc"}

Sorts

Pagination.PageSize

int32

The number of records per page, for example 1. Shouldn't exceed 200.

Pagination.PageNumber

int32

The page number to retrieve from results, for example 1

Filter.ComputerId

uuid | null

The Id of the Computer(Guid format), for example - 59A00329-87AC-49EC-BC2C-9B9E26F05185

Filter.Host

string

The host name of the Computer, for example - Computer1

Filter.HostType

string | null

enum

The host type of the Computer, for example - MicrosoftWindows, Linux

Allowed:

Filter.AgentVersion

string

The agent version of the Computer, example - 5.6.126.0

Filter.AdapterVersion

string

The adapter version of the Computer, example - 20.5.195.0

Filter.PackageManagerVersion

string

The Package Manager version on the Computer, example - 20.5.195.0

Filter.AuthorisationState

string

The state of the Computer, example - Authorised, Pending

Filter.LastConnected.Dates

array of date-times or null

Valid date formats for filter - 2020-12-24, 2020-12-24 19:09:47, 2020-12-24 19:09:47.6816562, 2020-12-24 19:09:47.6816562 +00:00

Filter.LastConnected.Dates

Filter.LastConnected.SelectionMode

string

enum

The selection mode of date criteria e.g single, multiple, range

Allowed:

Filter.PolicyRevisionStatus

string

Policy Revision Status, example - AwaitingLatestPolicy

Filter.PolicyId

uuid | null

Policy Id, example - 59A00329-87AC-49EC-BC2C-9B9E26F05185

Filter.PolicyName

string

Policy Name (Assigned Policy to Group/Endpoint), example - Policy1

Filter.HostPolicyName

string

Host Policy Name (Current Policy on Endpoint), example - Policy1

Filter.GroupId

uuid | null

Group Id, example - 59A00329-87AC-49EC-BC2C-9B9E26F05185

Filter.GroupName

string

Group Name, example - Group1

Filter.OS

string | null

enum

OS Name, example - Windows

Allowed:

Filter.Domain

string

Domain Name, example - BeyondTrust

Filter.Created.Dates

array of date-times or null

Valid date formats for filter - 2020-12-24, 2020-12-24 19:09:47, 2020-12-24 19:09:47.6816562, 2020-12-24 19:09:47.6816562 +00:00

Filter.Created.Dates

Filter.Created.SelectionMode

string

enum

The selection mode of date criteria e.g single, multiple, range

Allowed:

Filter.DuplicateCount.Min

int64

0 to 4294967295

Min Value of CountRange, example - 1,2,3

Filter.DuplicateCount.Max

int64

0 to 4294967295

Max Value of CountRange, example - 1,2,3

Filter.ConnectionStatus

array of strings

ConnectionStatus

Filter.ConnectionStatus

Filter.DaysDisconnected

int32 | null

DaysDisconnected

Filter.DaysSinceArchived

int32 | null

DaysSinceArchived

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Bad Request

401Unauthorized