Skip to content

API reference

Liveness

GET
/health

Liveness only. It probes no dependency and discloses no configuration, so a 200 here says the Worker is running, not that ClickHouse, D1 or the sync service are reachable. This is the one route that needs no authorization.

The match is exact: GET, with no query delimiter. /health?, /health?anything, or any other method still matches the deliberately opaque health route and returns 404 not_found — not 400 invalid_query and not 405.

The Worker is running.

object
status
required
string
Allowed value: ok
service
required
string
Allowed value: signalbraid-gateway
Example
{
"status": "ok",
"service": "signalbraid-gateway"
}

not_found — a query delimiter (including a bare ?) was present, or the method was not GET.

object
error
required
object
code
required
string
message
required
string
error
object
code
Allowed value: not_found