Get health

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

A liveness check for Docker and load balancers. Reveals nothing about the server; 503 while it isn’t ready.

Responses

200

The server is up.

application/json

object

status

required

Whether the server is serving.

string

Allowed values: ok starting stopping

Example

{
  "status": "ok"
}

503

The server is starting or shutting down.