Skip to content

`GET /api/v1/agents` — list agents from the persistent store.

GET
/api/v1/agents
curl --request GET \
--url https://example.com/api/v1/agents
status
string

Optional status filter: pending, approved, or rejected.

filter
string

Optional tag selection expression (e.g. env=production role=webserver).

List of agents

Media type application/json
Array<object>

A single agent in the GET /api/v1/agents response.

object
agent_version
required
string
attributes
required
object
key
additional properties
string
connected
required
boolean
connected_at
required
integer format: int64
initial_hostname
required
string
initial_ip
required
string
name

Operator-assigned, immutable name. null while the agent is pending.

string | null
node_id
required
string
status
required
string
tags
required
object
key
additional properties
string
updated_at
required
integer format: int64
Example generated
[
{
"agent_version": "example",
"attributes": {
"additionalProperty": "example"
},
"connected": true,
"connected_at": 1,
"initial_hostname": "example",
"initial_ip": "example",
"name": "example",
"node_id": "example",
"status": "example",
"tags": {
"additionalProperty": "example"
},
"updated_at": 1
}
]