Overview
Use /health to confirm that all 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 only returns a boolean ok value. It does not expose provider types, provider names, hostnames, URLs, credentials, or upstream error messages.
Request
curl https://api.bar9.me/healthCheck one service by name:
curl https://api.bar9.me/health/emailSupported 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. |