API reference

Health

1 operation.

GET /health

Whether the service is up, which release it runs, and whether its database is ready.

Operation id
getHealth
Who can call it
Anyone. No sign-in.
Credentials
None needed.

Answers

200 The service is up and its database is migrated. application/json

Field Type Always sent Notes
ok boolean yes
service string yes Values: availies-api .
environment string yes
release string yes
schema string yes

Refusals

Status Meaning Codes
503 The database lacks the migration this release needs, or a secret is missing.