Reference
Web API
The HTTP API used by the dashboard.
The dashboard uses a JSON API under /api. It authenticates with the session cookie and requires an Origin header that matches the site for every request that changes data. Responses are { "data": ... } or { "error": { "code", "message", "details" } }.
| Method and path | Purpose |
|---|---|
GET, POST /api/projects | List or create projects |
GET, PATCH, DELETE /api/projects/:id | Read, update, delete |
POST /api/projects/:id/archive, /restore, /duplicate | Lifecycle |
GET /api/projects/:id/export, POST /api/projects/import | Project files |
GET, POST /api/projects/:id/huds | List or create HUDs |
GET, PUT, PATCH, DELETE /api/huds/:id | Read, save, rename, delete a HUD |
GET, POST /api/projects/:id/versions | Snapshots |
PATCH, DELETE /api/versions/:id, POST /api/versions/:id/restore | Rename, delete, restore |
GET, POST /api/assets, PATCH, DELETE /api/assets/:id | Asset library |
GET, POST /api/projects/:id/fonts, PATCH, DELETE /api/fonts/:id | Fonts |
GET, POST /api/projects/:id/resource-pack | List builds, build |
GET /api/resource-packs/:id/download | Download a build |
GET, POST /api/servers | List servers, create a connection command |
PATCH, DELETE /api/servers/:id | Rename, disconnect |
POST /api/servers/:id/token, /deploy, /revoke | New command, deploy, revoke |
GET /api/licenses, POST /api/licenses/:id/reset | Your licenses |
Errors
| Status | Meaning |
|---|---|
| 401 | Not signed in |
| 403 | Not allowed, or the origin does not match |
| 404 | Not found, or owned by someone else |
| 409 | A limit was reached |
| 413 | Body too large |
| 422 | Validation failed; details lists the fields |
| 429 | Rate limited; see Retry-After |