Overview
Use /health to confirm that Bar9 runtime components are reachable. Use /health/:service to check a single component. These endpoints do not require a session or API key.
The health API returns only a boolean ok value. It does not expose provider types, provider names, hostnames, URLs, credentials, or upstream error messages.
GET /health
curl https://api.bar9.dev/health
This checks the complete runtime and returns 200 only when all required components are healthy.
GET /health/:service
curl https://api.bar9.dev/health/email
Supported service names are frontend, backend, database, sms, and email.
Response
{
"ok": true
}
When the checked service is down or unconfigured, the response is:
{
"ok": false
}
Status codes
| Status | Meaning |
|---|---|
200 |
The requested health check is healthy. |
404 |
The requested service name is unknown. |
503 |
The requested health check is down or unconfigured. |