Check readiness

GET

/system/health

const url = 'https://qinto-api.blotout.io/system/health';
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://qinto-api.blotout.io/system/health

Reports whether the API is ready to serve requests. Wire it to uptime monitors and deployment health checks.

How it works

A 503 means the API is temporarily not ready — retry with backoff rather than treating it as permanent.

Responses

200

The API is ready to serve requests.

application/json

object

status

required

Always success: the API is ready to serve requests.

string

Allowed values: success

Example

{
  "status": "success"
}

503

The API is temporarily not ready; retry with backoff.