Sign in

v1

latestOpenAPI 3.0.02026-07-17181627.7 KB
agents

List current Agents

get/agents

Query parameters

limitinteger

Size of the subset to retrieve.

offsetinteger

Number of items to skip during retrieval.

namestring

Name filter. Filtering is performed as a case-insensitive partial match.

order'name' | 'id'

Order type.

dir'asc' | 'desc'

Order direction.

tagsobject

Tags filter. Filtering is performed as a case-insensitive partial key value match.

Response

Data retrieved.

totalinteger

Total number of items.

offsetinteger

Number of items to skip during retrieval.

limitinteger

Maximum number of items to return in one page.

Example response

{
  "agents": [
    {
      "name": "my-agent1",
      "agent_tags": {
        "region": "eu",
        "node_type": "dns"
      },
      "orb_tags": {
        "region": "eu",
        "node_type": "dns"
      },
      "agent_metadata": {
        "region": "eu",
        "node_type": "dns"
      },
      "state": "online"
    }
  ]
}