Readiness check REST API

GET

/readyz

const url = 'https://hitkeep.com/readyz';
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://hitkeep.com/readyz

Readiness endpoint for leader state and shared or open tenant database availability. Recovery and operator-attention states return a stable reason with a short retry interval.

Responses

200

Ready

503

Not ready

application/json

object

reason

required

string

Allowed values: not_leader database_unavailable database_recovering database_needs_attention

retry_after_seconds

required

integer

>= 1

status

required

string

Allowed values: not_ready

Example

{
  "reason": "not_leader",
  "status": "not_ready"
}

Headers

Retry-After

integer

>= 1

Seconds before retrying the readiness check.