API Reference
Hades exposes two small HTTP services. Both are documented with interactive OpenAPI references, rendered directly from the specs generated from the code (make docs-api -> make docs-site-sync).
| Service | Interactive reference | Default address |
|---|---|---|
| HadesAPI - submit jobs | HadesAPI OpenAPI » | http://localhost:8080 |
| HadesLogManager - inspect logs/status | Log Manager OpenAPI » | http://localhost:8081 |
The raw specs are also available as JSON: /openapi/hades-api.json and /openapi/log-manager.json.
HadesAPI at a glance
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /ping | none | Liveness probe. |
POST | /build | Basic (when AUTH_KEY set) | Validate and enqueue a job. Returns { "message", "job_id" }. |
See Submitting Jobs for the payload schema and examples, and the interactive reference for the full contract.
HadesLogManager at a glance
| Method | Path | Description |
|---|---|---|
GET | /jobs | List known job IDs. |
GET | /jobs/{jobId}/status | Current build status, or 404. |
GET | /jobs/{jobId}/logs | Aggregated log entries. |
GET | /health | Liveness probe. |
The Log Manager is deployed by the Helm chart (hades-log-manager) and can also be run locally with make run.