Skip to content

Service health ​

Simple check that the API is up.

Check that the API is up ​

GET /health

Needs no sign-in. Use it to monitor whether the service responds.

Access: Public (no sign-in). Success status: 200.

Response

Health

FieldTypeRequiredConstraintsDescription
status"ok" | "degraded"yes
db"up" | "down"yes
versionstringyes
localestringyes

On error: ErroApi model.

Example

bash
curl -X GET "$API/health"

contato@presente.app.br