API Overview
Understand how the Noderax API is organized before drilling into the generated endpoint reference tree.
API Overview
The Noderax API is a NestJS control-plane API exposed under /api/v1 for most
application routes, with selected health routes intentionally exposed without
the prefix.
Documentation model
This section combines:
- hand-authored operational guides
- generated endpoint reference pages derived from a checked-in OpenAPI schema snapshot
Why the schema is checked in
The docs site is a separate repo and should not depend on a live production Swagger endpoint. Instead:
noderax-apiexports a deterministicopenapi.jsonnoderax-docskeeps a local schema snapshot underopenapi/openapi.json- the generated endpoint tree is produced from that local file
v1 intentionally avoids a live authenticated playground or cookie-forwarding proxy. The generated reference is read-only by design.
Read the reference by concern
Auth and workspace model
See how sessions, workspace scoping, and membership boundaries shape every operator-facing API call.
Realtime model
Understand websocket transport, room membership, and the event contract behind live UI behavior.
Update flows
Compare agent rollouts with installer-managed control-plane download/apply semantics.
Endpoint families
Covers login-adjacent flows, setup bootstrap, health routes, and other endpoints that must exist before the installed runtime is fully promoted.
Covers users, teams, workspaces, nodes, metrics, events, tasks, packages, diagnostics, and audit activity.
Covers the websocket contract, event model, and terminal-specific APIs used by the operator interface.
Covers both agent-update rollout endpoints and installer-managed control-plane update summary/download/apply endpoints.