---
title: "Readyz"
method: GET
path: "/readyz"
---

# Readyz

`GET /readyz`

## Request

- Base URL: `https://api-docs.session-exchange.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.session-exchange.com/readyz`
- Auth: none declared

Readiness. Anonymous: `{"ok": true}` (200) or `{"ok": false, "reason"}` (503 — the reason
is the same `ready_reason` the public /healthz already shows). With a platform credential — a
global admin, or a valid read / emit / admin token or member session of the default tenant —
the 200 body adds `data_dir`, `events_count`, `events_count_age_s`, `capacity` and
`ignored_events` (the fold's refusal counters; the per-producer module breakdown only for a
global admin)
(RR01-SEC-C04, RR03-SEC-10: host capacity and platform event volume are not public, and not
a workspace's business either). Any other credential gets `{"ok": true}`.

## Response `200`

Successful Response

- unknown

---

[API](https://skmtc.dev/session-exchange/apis/a4sx.md) · [All operations](https://skmtc.dev/session-exchange/apis/a4sx/llms.txt) · [OpenAPI document](https://skmtc.dev/session-exchange/apis/a4sx/revisions/abaefc33dfc7?raw)