Admin API¶
Sapsan expone el estado del servidor por HTTP. La API es compatible en formato con la Flussonic Streamer API v3, así que las integraciones existentes siguen funcionando.
Acceso¶
El acceso a la API está protegido por un usuario y una contraseña en la sección api_auth:
api_auth:
login: admin
password: secret
Endpoints¶
El prefijo base es /streamer/api/v3:
| Método y ruta | Qué devuelve |
|---|---|
GET /streamer/api/v3/streams |
lista de streams y su estado |
GET /streamer/api/v3/config |
configuración actual del servidor |
GET /streamer/api/v3/dvrs |
lista de almacenamientos DVR |
GET /streamer/api/v3/dvrs/{name} |
estado de un DVR concreto |
GET /streamer/api/v3/rproxy |
estado de la pasarela Peeklio y de los agentes |
GET /streamer/api/v3/monitoring/readiness |
sonda de readiness para orquestadores |
API nativa v4¶
La API nativa, aún en evolución, vive bajo el prefijo /streamer/api-v4:
| Ruta | Qué devuelve |
|---|---|
GET /listeners |
lista de listeners |
GET /streams, GET /streams/{name} |
streams y su estado |
GET /streams/stats, GET /streams-stats |
estadísticas de streams |
GET /sessions/stats |
estadísticas de sesiones |
GET /live-metrics, GET /sessions-metrics |
métricas de live y de sesiones |
GET /dvr, GET /dvr/catalog, GET /dvr/metrics |
estado del almacenamiento y del catálogo DVR |
POST /dvr/rebuild-index, GET (estado), DELETE (detener) |
reconstrucción del catálogo desde los discos |
POST /dvr/cleanup, GET /dvr/cleanup |
iniciar la limpieza del archivo / estado |
GET /runtime/metrics |
métricas del proceso en formato Prometheus |
GET /auth |
estado de la autorización |
GET /license/status |
estado de la licencia |
GET /rproxy/streampoint-agents |
agentes de la pasarela Peeklio |
Note
TODO: ejemplos de respuestas, gestión de streams por API (cuando existan operaciones de escritura).