API-Referenz¶

Ripster bietet eine REST-API für Steuerung/Verwaltung sowie einen WebSocket-Endpunkt für Echtzeit-Updates.

Basis-URL¶

http://localhost:3001

API-Prefix: /api

Beispiele:

• GET /api/health
• GET /api/pipeline/state

API-Gruppen¶

Authentifizierung¶

Es gibt keine eingebaute Authentifizierung. Ripster ist für lokalen Betrieb gedacht.

Fehlerformat¶

Fehler werden zentral als JSON geliefert:

{
  "error": {
    "message": "Job nicht gefunden.",
    "statusCode": 404,
    "reqId": "req_...",
    "details": [
      {
        "field": "name",
        "message": "Name darf nicht leer sein."
      }
    ]
  }
}

details ist optional (z. B. bei Validierungsfehlern).

Häufige Statuscodes¶