Skip to main content
GET
List on-premise agents.

Authorizations

Authorization
string
header
required

Enter your JWT token

Query Parameters

name
string | null

Optional name filter.

status
string | null

Optional status filter: WaitingForConnection, Online, Offline or Disabled. Case-insensitive.

offset
integer<int32>
default:0

Zero-based index of the first item to return. Defaults to 0.

top
integer<int32>
default:25

Maximum number of items to return (capped at 100). Defaults to 25.

Response

A paginated list of on-premise agents.

Offset-based paginated wrapper for a list of items.

items
object[]
required

The items in the current page.

totalCount
integer<int32>
required

Total number of items available across all pages.

offset
integer<int32>
required

Number of items skipped before this page (the requested offset).

top
integer<int32>
required

Maximum number of items requested for this page.