Skip to content

Liveness probe

GET
/healthz
curl --request GET \
--url https://api.aletheia-ops.com/healthz

OK

Media typeapplication/json

Body of GET /healthz (liveness)

object
status
string
Examplegenerated
{
"status": "example"
}

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleinternal_error
{
"code": "internal_error",
"message": "internal server error"
}