API reference OpenAPI 3.1
GET /ready

Deep readiness (load-balancer + Tier-2)

Checks postgres, redis and rule-set table; 503 with per-component detail on any failure.

Public — no authentication operation ready

Request

This endpoint has no request body.

curl "$MONICHEK_API/ready"
const res = await fetch(`${MONICHEK_API}/ready`, {
  method: "GET",
});

const data = await res.json();
import os
import requests

res = requests.get(
    f"{os.environ['MONICHEK_API']}/ready",
)
print(res.json())
$ch = curl_init(getenv('MONICHEK_API') . '/ready');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

200 OK ready application/json
{
  "status": "ready",
  "components": {
    "postgres": "up",
    "redis": "up"
  },
  "rule_sets": 1
}

Error responses

StatusMeaningBody
503 Service Unavailable not ready

Errors use the RFC 9457 problem format with a stable code.