Liveness 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

Registered ahead of the server-name check, so a probe addressing the server by IP rather than by its configured name still reaches it.

Note this is one of the two endpoints that does not use the {data, error} envelope: it predates the convention and is consumed by orchestrators rather than by this project’s own clients.

Responses

200

The server is up

application/json

object

status

required

string

Example

{
  "status": "ok"
}