Skip to content

Healthz service

/healthz is the liveness/readiness probe for operators — a way for process supervisors, load balancers and Kubernetes to ask the service "are you OK?". It is not meant for devices or users.

Access is restricted to the operator principal saadmin via HTTP Basic auth, with the password taken from the PANTAHUB_SA_ADMIN_SECRET server configuration. If that secret is unset, the endpoint is unusable by design.

sh
curl -s -u "saadmin:$PANTAHUB_SA_ADMIN_SECRET" \
  https://api.pantahub.com/healthz/
json
{
  "code": 0,
  "duration": 2706206,
  "start-time": "2017-06-29T23:50:28.09254266+02:00"
}

Interpret any HTTP status ≥ 400 as unhealthy; the body reports the check duration in nanoseconds.

In the self-hosted deployments, the same saadmin + PANTAHUB_SA_ADMIN_SECRET pair also guards the cron and callbacks endpoints — one operator credential for all three.

Endpoint reference

EndpointReference
GET /healthzHealth check