Skip to content

Health check

GET
/health

Two modes. Bare (no query) returns infra health for uptime monitors — 200 when the app and database are reachable, 503 otherwise. ?auth=1 additionally reports whether the request has a live session, useful for client-side connection monitors that need to tell "signed out" apart from "server unreachable".

Parameters

Query Parameters

auth

Pass 1 to also report authenticated: boolean so a client can distinguish "server up but signed out" from "server unreachable". Cheap — no extra DB call.

Type
string
Valid values
"1"

Responses

Health envelope. Returns 503 with status: "degraded" when the database is unreachable.

application/json
JSON
{
  
"status": "string",
  
"db": true,
  
"timestamp": "string",
  
"version": "string",
  
"authenticated": true,
  
"error": "string"
}

Playground

Server
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

OneBusiness · Built for businesses that work.