Admin API¶

Sapsan exposes server state over HTTP. The API is format-compatible with the Flussonic Streamer API v3, so existing integrations keep working.

Access¶

API access is protected by a login and password in the api_auth section:

api_auth:
  login: admin
  password: secret

The base prefix is /streamer/api/v3:

Method and path	Returns
`GET /streamer/api/v3/streams`	list of streams and their state
`GET /streamer/api/v3/config`	current server configuration
`GET /streamer/api/v3/dvrs`	list of DVR storages
`GET /streamer/api/v3/dvrs/{name}`	state of a specific DVR
`GET /streamer/api/v3/rproxy`	Peeklio gateway and agent state
`GET /streamer/api/v3/monitoring/readiness`	readiness probe for orchestrators

The evolving native API lives under the /streamer/api-v4 prefix:

Path	Returns
`GET /listeners`	listener list
`GET /streams`, `GET /streams/{name}`	streams and their state
`GET /streams/stats`, `GET /streams-stats`	stream statistics
`GET /sessions/stats`	session statistics
`GET /live-metrics`, `GET /sessions-metrics`	live and session metrics
`GET /dvr`, `GET /dvr/catalog`, `GET /dvr/metrics`	DVR storage and catalog state
`POST /dvr/rebuild-index`, `GET` (status), `DELETE` (stop)	catalog rebuild from disks
`POST /dvr/cleanup`, `GET /dvr/cleanup`	start archive cleanup / status
`GET /runtime/metrics`	process metrics in Prometheus format
`GET /auth`	authorization state
`GET /license/status`	license state
`GET /rproxy/streampoint-agents`	Peeklio gateway agents

Note

TODO: response examples, stream management via API (once writes appear).