Skip to content
CatalystCatalyst Docs

API & Developers

Catalyst exposes a REST API for everything the panel does, plus realtime channels for console output, metrics, and events.

Start here

Section titled “Start here”
  1. Authentication — sessions for the panel UI, API keys for integrations.
  2. Authorization — permissions and scopes.
  3. Errors — stable codes you can branch on.
  4. Pagination and rate limits.
  5. Realtime events — console streams, SSE, metrics.
  6. Guides — common workflows end to end.
  7. API reference — generated endpoint documentation.

Conventions

Section titled “Conventions”
  • Base path: /api (for example, /api/servers, /api/nodes).
  • JSON everywhere, UTF-8.
  • List endpoints paginate with page/limit (defaults 1/20).
  • Errors carry a stable machine-readable code in addition to the message — branch on the code, never on English text.

Source of truth

Section titled “Source of truth”

The API reference is generated from the backend’s route definitions, not hand-written. If the reference and a guide disagree, the reference (and the actual behavior) wins — and please report the mismatch so the guide gets fixed.