Skip to main content
GET
Get Agents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

search
string | null
health
string | null

healthy, warning, critical

status
string | null

online, offline

Response

Successful Response

List of agents.

agents
BanAgentItem · object[]
summary
BanAgentsSummary · object | null

Agents summary statistics.

total
integer
default:0
online
integer
default:0