Saúde da API
Informa se a API está respondendo, para monitores, balanceadores e checagens de deploy.
Use esta rota para saber se a API está de pé. Ela confere o banco de dados principal e a pressão de memória e devolve um resumo de uma palavra. Não exige token e não depende da loja.
/api/v1/healthPúblicaEstado resumido da API
A resposta pode ser guardada em cache por até 10 segundos (Cache-Control: public, max-age=10), então chamar com mais frequência do que isso não traz informação nova. Detalhes internos (conexões, memória, versão) não são expostos na rota pública.
Exemplo de requisição
bash
curl "$BASE_URL/api/v1/health"Resposta
200API saudável
json
{ "status": "healthy", "timestamp": "2026-10-11T20:50:16Z" }Campos da resposta
statusstringhealthydegradedunhealthyhealthy: tudo certo. degraded: responde, mas com pressão de memória ou sem banco configurado. unhealthy: o banco principal não respondeu.timestampstringMomento da checagem, RFC 3339 em UTC.
Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 503 | O banco de dados principal não respondeu em 3 segundos (status = unhealthy) | {"status":"unhealthy","timestamp":"2026-10-11T20:50:16Z"} |