Admin API¶
O Sapsan expõe o estado do servidor por HTTP. A API é compatível em formato com a Flussonic Streamer API v3, então as integrações existentes continuam funcionando.
Acesso¶
O acesso à API é protegido por um login e uma senha na seção api_auth:
api_auth:
login: admin
password: secret
Endpoints¶
O prefixo base é /streamer/api/v3:
| Método e caminho | O que retorna |
|---|---|
GET /streamer/api/v3/streams |
lista de streams e seu estado |
GET /streamer/api/v3/config |
configuração atual do servidor |
GET /streamer/api/v3/dvrs |
lista de armazenamentos DVR |
GET /streamer/api/v3/dvrs/{name} |
estado de um DVR específico |
GET /streamer/api/v3/rproxy |
estado do gateway Peeklio e dos agentes |
GET /streamer/api/v3/monitoring/readiness |
sonda de readiness para orquestradores |
API nativa v4¶
A API nativa, ainda em evolução, vive sob o prefixo /streamer/api-v4:
| Caminho | O que retorna |
|---|---|
GET /listeners |
lista de listeners |
GET /streams, GET /streams/{name} |
streams e seu estado |
GET /streams/stats, GET /streams-stats |
estatísticas de streams |
GET /sessions/stats |
estatísticas de sessões |
GET /live-metrics, GET /sessions-metrics |
métricas de live e de sessões |
GET /dvr, GET /dvr/catalog, GET /dvr/metrics |
estado do armazenamento e do catálogo DVR |
POST /dvr/rebuild-index, GET (status), DELETE (parar) |
reconstrução do catálogo a partir dos discos |
POST /dvr/cleanup, GET /dvr/cleanup |
iniciar a limpeza do arquivo / status |
GET /runtime/metrics |
métricas do processo em formato Prometheus |
GET /auth |
estado da autorização |
GET /license/status |
estado da licença |
GET /rproxy/streampoint-agents |
agentes do gateway Peeklio |
Note
TODO: exemplos de respostas, gestão de streams pela API (quando surgirem operações de escrita).