Observabilidade
Health
Probe combinado, processo, banco de dados e dependências opcionais
GET
Auth: Nenhuma • Rate-limit: Bypass (fora do limite global) • Idempotente: sim
Descrição
Endpoint aberto (sem token) que devolve um snapshot do estado da API a partir de checks de dependências (DB sempre, mais probes opcionais como S3 quando configurado). Bypassa rate-limit e CORS para que monitores externos possam consultá-lo sem credenciais.Exemplo
Resposta, saudável
Resposta, degradado
503 Service Unavailable
Campos
Entradas em
checks aparecem condicionalmente: db está sempre presente; outras dependências (ex.: s3) só aparecem quando configuradas no servidor.Uso em uptime monitors
Aponte um serviço de monitoramento (UptimeRobot, Better Stack, Pingdom, etc.) paraGET /health:
200→ API saudável.503→ API degradada, dispare o alerta.
Notas
- Não é necessário enviar header
token. Tokens enviados são ignorados. - O endpoint não conta para o limite global de
100 req/min, pode ser chamado sem restrição por probes externas.
Relacionados
Visão geral
Posicionamento do endpoint dentro do ciclo de vida da API.
Tipos de erro
Tabela de status HTTP usados pela RyzeAPI.