API Reference

The full interactive API reference is available at /api-reference.

It is generated automatically from the OpenAPI spec built into the server and documents all endpoints, request/response schemas, and authentication requirements.

Interactive Explorer

→ Open API Reference

The explorer lets you browse all endpoints, inspect schemas, and send live requests directly from the browser using your Bearer token.

Authentication

All management API endpoints require a Bearer token:


curl -H "Authorization: Bearer YOUR_TOKEN" \
  http://localhost:8080/api/projects

Create tokens in Settings → API Tokens in the dashboard, or via:


POST /api/tokens
Content-Type: application/json
Authorization: Bearer EXISTING_TOKEN
 
{ "description": "CI/CD Pipeline" }

Self-hosted spec

The server exposes the spec directly when built with the openapi feature:

Endpoint	Description
`GET /api-docs/openapi.json`	Raw OpenAPI 3.x JSON spec
`GET /docs`	Scalar interactive UI served by the server itself

Both endpoints are public — no authentication required.

Generating the spec file


cargo run --bin gen_openapi --features openapi
# writes apps/server/openapi.json

Production builds

The openapi feature is not enabled by default. Production binaries ship without any utoipa code:


cargo build --release                         # no openapi, no extra deps
cargo build --release --features openapi      # includes /docs and /api-docs/openapi.json