Observabilidad
Health
Sondeo combinado, proceso, base de datos y dependencias opcionales
GET
Auth: Ninguna • Rate limit: Bypass (fuera del límite global) • Idempotente: sí
Descripción
Endpoint abierto (sin token) que devuelve una instantánea del estado de la API basada en verificaciones de dependencias (DB siempre, además de sondeos opcionales como S3 cuando esté configurado). Omite el rate limit y CORS para que monitores externos puedan consultarlo sin credenciales.Ejemplo
Respuesta, saludable
Respuesta, degradada
503 Service Unavailable
Campos
Las entradas en
checks aparecen condicionalmente: db siempre está presente; otras dependencias (p. ej., s3) solo aparecen cuando están configuradas en el servidor.Uso en monitores de uptime
Apunta un servicio de monitoreo (UptimeRobot, Better Stack, Pingdom, etc.) aGET /health:
200→ API saludable.503→ API degradada, dispara la alerta.
Notas
- No es necesario enviar la cabecera
token. Los tokens enviados se ignoran. - El endpoint no cuenta para el límite global de
100 req/min, y puede llamarse sin restricción por sondas externas.
Relacionado
Resumen
Dónde se ubica el endpoint en el ciclo de vida de la API.
Tipos de error
Tabla de estados HTTP utilizados por RyzeAPI.