The Stream Trace HTTP API surface, grouped by area.
Stream Trace’s web UI is built on a REST API served under the /api prefix. The
same API is available to scripts and integrations.
Authentication
All endpoints except health require authentication. Send the access token as a
bearer token, or use the session cookies issued at login; state-changing requests
(POST/PUT/PATCH/DELETE) also require the CSRF token. See
Authentication. Results are filtered by the caller’s
permissions - you only see streams, DLQ cases, and traces your teams can access.
Health
| Method | Path | Notes |
|---|
| GET | /api/health/live | Liveness; no auth. |
| GET | /api/health/ready | Readiness (DB, NATS, modules); no auth. |
Auth
| Method | Path |
|---|
| GET | /api/auth/status |
| POST | /api/auth/bootstrap |
| POST | /api/auth/login |
| POST | /api/auth/signup |
| POST | /api/auth/refresh |
| POST | /api/auth/logout |
| GET | /api/auth/me |
| POST | /api/auth/password-reset/request · /confirm |
| POST | /api/auth/email-verification/request · /confirm |
| GET | /api/auth/oidc/:provider/login · /callback |
| GET | /api/auth/role-catalog |
Streams & messages
| Method | Path |
|---|
| GET | /api/nats/streams |
| GET | /api/nats/streams/:streamName |
| GET | /api/nats/streams/:streamName/subjects |
| GET | /api/nats/streams/:streamName/consumers |
| GET | /api/nats/streams/:streamName/consumers/summary |
| GET | /api/nats/streams/:streamName/messages |
| GET | /api/nats/streams/:streamName/messages/count |
| GET | /api/nats/streams/:streamName/messages/:sequence |
| POST | /api/nats/streams/:streamName/messages/publish |
| POST | /api/nats/streams/:streamName/messages/export |
Replay
| Method | Path |
|---|
| POST | /api/nats/replay/preview · /preview-bulk |
| POST | /api/nats/replay · /bulk |
Throughput
| Method | Path |
|---|
| GET | /api/nats/streams/throughput/settings |
| GET | /api/nats/streams/:streamName/throughput |
DLQ
| Method | Path |
|---|
| GET | /api/nats/dlq/messages |
| GET | /api/nats/dlq/messages/summary |
| GET | /api/nats/dlq/messages/:caseId |
| GET | /api/nats/dlq/audit |
| POST | /api/nats/dlq/messages/retry · /discard |
Traces
| Method | Path |
|---|
| GET | /api/traces/settings |
| GET | /api/traces/:traceId |
Admin & audit
| Method | Path |
|---|
| GET | /api/admin/audit-events |
| GET | /api/admin/auth/settings |
| GET/POST/PATCH | /api/admin/users · /users/invite · /users/:userId · /users/:userId/revoke-sessions |
| GET/POST/PATCH | /api/admin/teams · /teams/:teamId · /teams/:teamId/members/:userId |
| GET/POST/PATCH/DELETE | /api/admin/roles · /roles/:roleId |
| GET/PUT/DELETE | /api/admin/stream-ownership · /stream-ownership/:streamName |