Readiness Check

GET

/api/health/ready

const url = 'https://example.com/api/health/ready';
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/api/health/ready

Readiness check: main DB, critical DB and Redis must all answer.

200 {"status": "ready", ...} when every dependency is healthy. 503 {"status": "not ready"} otherwise, with no per-dependency or exception detail in the body (logged server-side instead).

Responses

200

Successful Response

application/json

Example ^generated

example

Readiness Check

Responses

200

Example generated

Example ^generated