API
Common patterns and recipes for working with ShowRunner.
API – Using the REST Endpoints
Once the server is started (sr start), all plugin routes are available.
List shows via HTTP
Create a show via HTTP
Manage layers via HTTP
curl http://localhost:8000/db/layer-types
curl http://localhost:8000/db/shows/1/layers
curl -X POST "http://localhost:8000/db/shows/1/layers?name=FX&type=generic&color=pink"
curl -X PUT "http://localhost:8000/db/layers/6?name=FX2"
curl -X DELETE http://localhost:8000/db/layers/6
An unknown type or colour returns 422; deleting a layer that cues use returns 409.
Check a plugin's status
Every built-in plugin exposes a health/index endpoint at its prefix:
curl http://localhost:8000/recorder/ # ShowRecorder
curl http://localhost:8000/cmd/ # ShowCmd
curl http://localhost:8000/mixer/ # ShowMixer
Web UI pages
The NiceGUI-powered pages are browser-only (not REST):
| URL | Plugin | Description |
|---|---|---|
| http://localhost:8000/ | ShowDashboard | Show selector and control dashboard |
| http://localhost:8000/script | ShowScripter | Script viewer with drag-and-drop cue placement |
| http://localhost:8000/admin | ShowAdmin | SQLAdmin CRUD interface (requires admin group) |
Admin Panel
The admin panel requires the optional admin dependency group:
The admin panel provides full CRUD for Shows, Scripts, CueLists, Cues, Actors, CueLogs, and Config.