Readiness probe

GET

/health/ready

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

Returns 200 only when Postgres and Redis are both reachable; 503 otherwise.

Responses

200

Default Response

application/json

object

status

required

string

Allowed values: ready

Example

{
  "status": "ready"
}

503

Default Response

application/json

object

status

required

string

Allowed values: not_ready

checks

required

object

postgres

required

string

redis

required

string

Example

{
  "status": "not_ready"
}