Liveness/readiness probe

GET

/healthz

const url = 'https://example.com/healthz';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/healthz

Returns subsystem health only (invariant #9) — no internal addresses, dependency trees, or config values. Exempt from authentication (invariant #1).

Responses

200

The gateway is healthy.

application/json

object

status

required

string

Example

{
  "status": "ok"
}