5.0 KiB
5.0 KiB
API endpoints
Roller nedenfor er den tilsigtede adgangsrolle for Release 1.0. Den nuværende kodebase dokumenterer rollerne, men håndhæver dem endnu ikke konsekvent i runtime.
| Metode | Sti | Rolle | Formål |
|---|---|---|---|
GET |
/api/v1/health |
Read only | Health check til lokal drift og monitoring. |
GET |
/api/v1/system/status |
Read only | Samlet systemstatus med engine, telemetri og BPM. |
GET |
/api/v1/system/diagnostics |
Administrator | Udvidet diagnostik til support og bundle. |
POST |
/api/v1/system/restart-service |
Administrator | Planlægger restart af TuxDMX-servicen på Linux-værten. |
GET |
/api/v1/dmx/status |
Read only | DMX-engine status og backendforbindelse. |
GET |
/api/v1/dmx/devices |
Operator | Liste over tilgængelige DMX-backends/devices. |
GET |
/api/v1/dmx/universes |
Operator | Oversigt over univers-konfiguration. |
GET |
/api/v1/dmx/frame |
Read only | Aktuelt DMX-frame og source-map. |
POST |
/api/v1/dmx/test-channel |
Operator | Midlertidig kanaltest til setup/diagnostik. |
POST |
/api/v1/dmx/blackout |
Operator | Aktiverer blackout med højeste prioritet. |
POST |
/api/v1/dmx/release-blackout |
Operator | Frigiver blackout. |
GET |
/api/v1/fixtures |
Operator | Lister lokalt importerede fixtures. |
POST |
/api/v1/fixtures/search-ofl |
Operator | Søger fixtures via OFL eller lokal fallback. |
POST |
/api/v1/fixtures/preview-ofl |
Operator | Henter preview og normaliseret modeoversigt før import. |
POST |
/api/v1/fixtures/import-ofl |
Operator | Importerer fixture fra OFL til lokal cache/runtime. |
POST |
/api/v1/fixtures/import-file |
Operator | Importerer fixture fra lokal/custom payload. |
POST |
/api/v1/fixtures/custom |
Operator | Opretter custom fixture uden OFL. |
GET |
/api/v1/fixtures/{id} |
Operator | Henter ét lokalt fixture. |
PUT |
/api/v1/fixtures/{id} |
Operator | Opdaterer et lokalt fixture. |
DELETE |
/api/v1/fixtures/{id} |
Administrator | Sletter et lokalt fixture. |
GET |
/api/v1/patch |
Operator | Lister patch-entries. |
POST |
/api/v1/patch |
Operator | Opretter patch-entry. |
PUT |
/api/v1/patch/{id} |
Operator | Opdaterer patch-entry. |
DELETE |
/api/v1/patch/{id} |
Operator | Sletter patch-entry. |
POST |
/api/v1/patch/validate |
Operator | Validerer startadresse og kanalantal. |
GET |
/api/v1/scenes |
Operator | Lister scener. |
POST |
/api/v1/scenes |
Operator | Opretter scene. |
GET |
/api/v1/scenes/{id} |
Operator | Henter scene. |
PUT |
/api/v1/scenes/{id} |
Operator | Opdaterer scene. |
DELETE |
/api/v1/scenes/{id} |
Operator | Sletter scene. |
POST |
/api/v1/scenes/{slug}/activate |
Operator | Aktiverer scene på engine-stacken. |
POST |
/api/v1/scenes/{slug}/release |
Operator | Frigiver scene-layer. |
GET |
/api/v1/effects |
Operator | Lister effekter. |
POST |
/api/v1/effects |
Operator | Opretter effekt. |
PUT |
/api/v1/effects/{id} |
Operator | Opdaterer effekt. |
DELETE |
/api/v1/effects/{id} |
Operator | Sletter effekt. |
POST |
/api/v1/effects/{slug}/trigger |
Operator | Trigger effekt på engine-stacken. |
POST |
/api/v1/effects/{slug}/stop |
Operator | Stopper aktiv effekt. |
GET |
/api/v1/bpm/status |
Read only | Aktuel BPM-status, mode og confidence. |
POST |
/api/v1/bpm/manual |
Operator | Sætter manuel BPM. |
POST |
/api/v1/bpm/tap |
Operator | Registrerer tap-tempo. |
POST |
/api/v1/bpm/audio/start |
Operator | Starter audioanalyse mod valgt ALSA- eller syntetisk inputdevice. |
POST |
/api/v1/bpm/audio/stop |
Operator | Stopper audio-mode. |
POST |
/api/v1/bpm/external |
Operator | Sætter BPM fra ekstern kilde/API. |
GET |
/api/v1/bpm/devices |
Operator | Lister tilgængelige BPM-devices/kilder. |
GET |
/api/v1/integrations/mixitup |
Administrator | Lister MixItUp-integrationer. |
POST |
/api/v1/integrations/mixitup |
Administrator | Opretter MixItUp-integration. |
PUT |
/api/v1/integrations/mixitup/{id} |
Administrator | Opdaterer MixItUp-integration. |
DELETE |
/api/v1/integrations/mixitup/{id} |
Administrator | Sletter MixItUp-integration. |
POST |
/api/v1/integrations/mixitup/{id}/test |
Administrator | Tester MixItUp-integration. |
POST |
/api/v1/triggers/{slug} |
API token | Hurtigt triggerendpoint til MixItUp/Twitch. |
GET |
/api/v1/telemetry/live |
Read only | Aktuel telemetri. |
GET |
/api/v1/telemetry/history |
Read only | Historiske samples. |
GET |
/api/v1/events |
Read only | Nylige systemevents. |
GET |
/api/v1/logs |
Administrator | Hændelser/logfeed. |
POST |
/api/v1/backups |
Administrator | Opretter ZIP-backup i simulator/runtime. |
GET |
/api/v1/backups |
Administrator | Lister tilgængelige backups. |
POST |
/api/v1/backups/{id}/restore |
Administrator | Gendanner backup og opretter pre-restore backup. |
DELETE |
/api/v1/backups/{id} |
Administrator | Sletter backuparkiv. |