Agents

List organization capture agents

GET
/organizations/{organizationId}/agents

Path Parameters

organizationId*string
Formatuuid

Query Parameters

page?integer
Range0 <= value
Default0
pageSize?integer
Range1 <= value <= 100
Default20
q?string
Lengthlength <= 256
status?string

Value in

  • "pending"
  • "online"
  • "offline"
  • "decommissioned"

Header Parameters

x-organization-role*string

Portal impersonation role (pair with x-organization-id)

Value in

  • "ORG_ADMIN"
  • "ORG_MEMBER"
x-organization-id*string

Must match the organizationId path segment

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents" \  -H "x-organization-role: ORG_ADMIN" \  -H "x-organization-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "items": [    {      "id": "string",      "name": "string",      "status": "string",      "hostname": "string",      "platform": "string",      "agentVersion": "string",      "lastHeartbeatAt": "2019-08-24T14:15:22Z",      "enabled": true    }  ],  "total": 0}
{  "message": "string"}
{  "message": "string"}