Documentation
Backend API
Route groups exposed by the Rust Axum backend, including auth, operations, ANH reports, edge management, telemetry, billing, and OpenAPI docs.
Status: VerifiedSources: 2
The backend binds on port 8000 and exposes health, Swagger UI, OpenAPI YAML, Prometheus metrics, REST API groups, and a WebSocket telemetry stream guarded by a short-lived ticket endpoint.
| Route group | Verified surface |
|---|---|
| /docs and /docs/openapi.yaml | Swagger UI and OpenAPI YAML from backend handlers |
| /api/auth | Login, refresh, logout, 2FA, registration, invitations, setup, request-access |
| /api/admin and /api/platform | User, role, access request, billing, platform operator, and 2FA administration surfaces |
| /api/edge | Projects, assets, devices, variables, deployments, agent logs/health, OTA, update info, OPC UA scan |
| /api/telemetry and /api/ws/telemetry | Telemetry ingestion/history and WebSocket telemetry streaming via one-time tickets |
| /api/anh, /api/movements, /api/downtime, /api/well-tests, /api/lab-results, /api/meters/readings | ANH reporting and operational data entry/query groups |
Pending validation
- Authentication and authorization details for each route group should be reviewed against handler extractors and middleware before writing public API examples.
- Request/response schemas should be generated from the backend OpenAPI artifact rather than rewritten manually.
Source basis
- services/backend-api/src/main.rs
- services/backend-api/src/handlers/docs.rs