API reference · Public
Deployment health
GET/api/healthNo key
200 with ok true when the database is reachable, 503 with ok false when it is not. A container or platform check may key on either the status code or the flag; both say the same thing.
Answer 200
The database is reachable.
| Field | Type | What it is |
|---|---|---|
| ok | boolean | True: the database answered. |
| db | boolean | Same signal as ok, named for what it measures. |
| upstreamConfigured | boolean | Whether this deployment can serve inference at all. |
| sessionSecretPinned | boolean | Whether ANTIMATTER_SESSION_SECRET is set. False means sessions and stored provider keys do not survive a restart. |
Errors
- 503The database is unreachable, so this instance cannot serve.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.