Skip to content

Health

Liveness + version probe. Both are public — no auth required. Suitable for ingress / load-balancer health checks and client-server compatibility assertions.

Health


Liveness probe

GET
/api/healthz

Returns 200 when the control plane is up. No auth. Suitable for ingress / load-balancer health checks.

Responses

The control plane is responding.

application/json
JSON
{
"status": "ok"
}

Playground

Samples


API version + build commit

GET
/api/version

Use this to assert client/server compatibility. The api field follows semver; the commit field is the git SHA of the running build.

Responses

API version metadata.

application/json
JSON
{
"api": "0.10.0",
"commit": "a1b2c3d"
}

Playground

Samples


Powered by VitePress OpenAPI

Released under the GPL v3 license.