Zum Inhalt

Anhang: API-Referenz

REST- und WebSocket-Schnittstellen für Integration, Automatisierung und Debugging.

Basis-URL

http://localhost:3001

API-Prefix: /api

API-Gruppen

  • Health

    Service-Liveness.

    GET /api/health

  • Pipeline API

    Analyse, Start/Retry/Cancel, Queue, Re-Encode.

    Pipeline API

  • Settings API

    Einstellungen, Skripte/Ketten, User-Presets.

    Settings API

  • History API

    Job-Historie, Orphan-Import, Löschoperationen.

    History API

  • Cron API

    Zeitgesteuerte Skript-/Kettenausführung.

    Cron API

  • Converter API

    Datei-Explorer, Upload, Job-Verwaltung für den Converter.

    Converter API

  • Downloads API

    Download-Queue für Ausgabedateien aus der Job-Historie.

    Downloads API

  • Runtime Activities API

    Laufende und abgeschlossene Aktivitäten (Skripte, Ketten, Cron, Tasks).

    Runtime Activities

  • :material-websocket: WebSocket Events

    Pipeline-, Queue-, Disk-, Settings-, Cron-, Converter- und Download-Events.

    WebSocket

Hinweis

Ripster hat keine eingebaute Authentifizierung und ist für lokalen, geschützten Betrieb gedacht.