Skip to content

Admin API

Sapsan отдает состояние сервера по HTTP. API совместимо по формату с Flussonic Streamer API v3 — существующие интеграции продолжают работать.

Доступ

Доступ к API защищается логином и паролем в секции api_auth:

api_auth:
  login: admin
  password: secret

Эндпоинты

Базовый префикс — /streamer/api/v3:

Метод и путь Что возвращает
GET /streamer/api/v3/streams список потоков и их состояние
GET /streamer/api/v3/config текущая конфигурация сервера
GET /streamer/api/v3/dvrs список DVR-хранилищ
GET /streamer/api/v3/dvrs/{name} состояние конкретного DVR
GET /streamer/api/v3/rproxy состояние шлюза Peeklio и агентов
GET /streamer/api/v3/monitoring/readiness readiness-проба для оркестраторов

Нативное API v4

Развивающееся нативное API живет по префиксу /streamer/api-v4:

Путь Что возвращает
GET /listeners список слушателей
GET /streams, GET /streams/{name} потоки и их состояние
GET /streams/stats, GET /streams-stats статистика потоков
GET /sessions/stats статистика сессий
GET /live-metrics, GET /sessions-metrics метрики лайва и сессий
GET /dvr, GET /dvr/catalog, GET /dvr/metrics состояние DVR-хранилища и каталога
POST /dvr/rebuild-index, GET (статус), DELETE (остановить) перестройка каталога с дисков
POST /dvr/cleanup, GET /dvr/cleanup запустить очистку архива / статус
GET /runtime/metrics метрики процесса в формате Prometheus
GET /auth состояние авторизации
GET /license/status состояние лицензии
GET /rproxy/streampoint-agents агенты шлюза Peeklio

Note

TODO: примеры ответов, управление потоками через API (когда появится запись).

Что дальше