List agents (paginated)

GET

/agents

Contract

Parameter	Value
Section	agents
Authentication	CookieAuth
Consumes	not required
Produces	application/json

Parameters

6 parameters

Name	Location	Required	Type	Description
input	query	no	string	Search by hostname or IP address
group_id	query	no	string	Filter by group ID
count	query	yes	integer	Page size
page	query	yes	integer	Page number, starting at 1
key	query	yes	string	Sort field
order	query	yes	enum(asc, desc)	Sort direction

"asc"

Responses

3 responses

Status	Description	Type
200	Successful response	object
400	Invalid query parameters	object
500	Internal server error	object

Response 200: object

{
  "cursor": {
    "count": 0,
    "currentPage": 0,
    "totalPages": 0,
    "totalRows": 0
  },
  "data": [
    {
      "caps": [
        "<string>"
      ],
      "cores": 0,
      "createdAt": "<string>",
      "hostname": "<string>",
      "id": 0,
      "interfaces": [
        {
          "address": "<string>",
          "deviceId": "<string>",
          "driver": "<string>",
          "name": "<string>",
          "vendor": "<string>"
        }
      ],
      "ip": "<string>",
      "online": true,
      "port": 0,
      "synced": true,
      "updatedAt": "<string>",
      "version": "<string>"
    }
  ]
}

{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }