NoteBugsDocs

Referência da API

Sistema

Saúde e versão.

/api/health é usada pelo healthcheck do Compose e é a única rota fora de /api/auth que responde sem credencial.

GET/api/health
Papel: nenhum

O healthcheck: a aplicação está de pé e o banco responde.

Requisição

curl -s http://localhost:3000/api/health

Resposta200

{ "status": "ok", "db": "up" }

É a única rota fora de /api/auth que responde sem credencial: o healthcheck do Compose não tem credencial para apresentar.

GET/api/version
Papel: Leitor

Versão, id do build, quando foi compilado e quando o processo subiu.

Requisição

curl -s http://localhost:3000/api/version \
  -H "Authorization: Bearer $TOKEN"

Resposta200

{
  "version": "1.0.0",
  "buildId": "83e365e17fb0",
  "builtAt": "2026-09-01T01:46:05.578Z",
  "startedAt": "2026-09-09T00:57:40.514Z"
}

Respostas de erro

CódigoQuando acontece
401Sem credencial, ou com uma que não vale mais. Mande o cookie de sessão ou o cabeçalho Authorization: Bearer.