Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

O módulo Observabilidade expõe um único endpoint, GET /health, para você verificar se a API está saudável. Ele não exige autenticação e bypassa rate-limit e CORS, para que monitores externos possam consultá-lo sem credenciais.

​
Endpoint

Health

GET /health, probe combinado (processo + DB + dependências opcionais como S3 quando configurado).

​
Como usar

Aponte um uptime monitor (UptimeRobot, Better Stack, Pingdom, etc.) para GET /health:
  • 200 → API saudável.
  • 503 → API degradada, dispare o alerta.

​
Relacionados

Rate limit & CORS

Limites globais e regras de CORS, /health está fora deles.

Tipos de erro

Como interpretar os códigos HTTP retornados pela API.