Skip to content

The API

Andrea de Ruvo edited this page Aug 18, 2026 · 1 revision

The API

Everything the page does, it does over HTTP, and the description is generated from the routes themselves: docs/openapi.json. A test fails if it drifts, so it cannot quietly start describing a board that does not exist.

GET /api/board every machine, as of the last sweep — and never a machine's token
POST /api/report a machine announcing itself; answers with anything queued for it
POST /api/do/{machine}/{what}/{action} start or stop something, or argus itself
DELETE /api/machines/{name} take an announced machine off the board for good
GET /api/journal what was done here, and what was refused
GET /api/languages, GET /api/language/{code} the catalogues
GET /api/health is the board itself up

Clone this wiki locally