Documentation API
3 endpoints. Request and response schemas are described on the schemas page; the other tags are listed in the API index.
Endpoints
GET /api/reference
API reference
Interactive API documentation (Scalar), served from the binary. The legacy /swagger and /swagger/ paths redirect here. Answers 404 when api.docs.enabled is false.
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | API reference HTML | - |
404 | The API reference is disabled | - |
GET /api/v1/openapi.json
OpenAPI specification
Returns the OpenAPI 3.0 specification in JSON format
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | OpenAPI specification | application/json: object |
GET /api/v1/openapi.yaml
OpenAPI specification (YAML)
Returns the OpenAPI 3.0 specification in YAML format
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | OpenAPI specification | application/yaml: object |