Skip to main content
GET
List Observer Agents and whether each is online

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Scopes

read:agents

Query Parameters

limit
integer
default:50

Page size. Out-of-range values are clamped.

Required range: 1 <= x <= 200
cursor
string

Opaque cursor from the previous page's next_cursor.

name
string

Only agents with exactly this name.

include
enum<string>

install: add every install snippet (and env). Omit it for the small default response.

Available options:
install
target
enum<string>

Add the install snippet for this one target (and env): docker, compose, kubernetes, systemd (Linux), launchd (macOS) or binary (Linux or macOS, foreground).

Available options:
docker,
compose,
kubernetes,
systemd,
launchd,
binary

Response

ok

items
object[]
required
next_cursor
string | null