System API
5 endpoints. Request and response schemas are described on the schemas page; the other tags are listed in the API index.
Endpoints
GET /api/v1/admin/system/info
Detailed system information
Administrator-only runtime and build details
Responses
| Status | Description | Body |
|---|---|---|
200 | System information | application/json: SystemInfo |
403 | Administrator access required | - |
GET /api/v1/system/info
System information
Returns the public version and health status. Detailed build and runtime information is available to administrators at /api/v1/admin/system/info
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | System information | application/json: PublicSystemInfo |
GET /health
Health check
Returns the health status of the server and its components
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | Health status | application/json: HealthResponse |
GET /metrics
Prometheus metrics
Returns Prometheus-format metrics
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | Metrics in Prometheus format | text/plain: string |
401 | Unauthorized: the endpoint needs the METRICS_AUTH_TOKEN bearer token and answers 401 for every caller while none is configured | - |
GET /ready
Readiness check
Returns whether the server is ready to accept requests
Authentication: none (public endpoint).
Responses
| Status | Description | Body |
|---|---|---|
200 | Server is ready | application/json: ReadyResponse |
503 | Server is not ready | application/json: ReadyResponse |