FixVibe

// docs / rest api

REST API

Bearer-authenticated JSON API for scan automation, scan status, and findings. Passive scans are available through REST; active scans are available for paid plans only after the domain is verified and explicitly authorized in the dashboard.

Authentifizierung

Jeder Request muss im Authorization-Header einen Bearer-Token tragen. Tokens werden unter Konto → API-Tokens ausgegeben; der Klartext wird dir bei der Erstellung genau einmal angezeigt. Wird ein Token widerrufen, liefert der nächste Aufruf 401.

bash
curl -H "Authorization: Bearer fxv_..." \
  https://fixvibe.app/api/v1/scans

Token-Format: fxv_ gefolgt von 43 base64url-Zeichen. Im Ruhezustand als SHA-256-Hash gespeichert; der Klartext wird serverseitig nie persistiert.

Rate Limits

Zwei Fenster für jeden authentifizierten Request: 10 req/sec burst und 60 req/min steady, beide auf dem Bearer-Hash keyed. Kontingentdurchsetzung (monatliche Scan-Limits) liegt darüber; siehe Kontingente & Limits.

Paginierung

Listen-Endpunkte (/api/v1/scans, /api/v1/findings) verwenden Cursor-basierte Paginierung, keyed auf (created_at, id) in absteigender Reihenfolge. Übergib ?cursor=<next_cursor>, um die nächste Seite zu laden. Der Cursor bleibt bei gleichzeitigen Schreibvorgängen korrekt (kein OFFSET skew).

Fehlerformate

Jeder Fehler ist ein JSON-Objekt mit mindestens einem error-Key.

jsonc
{ "error": "invalid_token" }                              // 401
{ "error": "forbidden" }                                  // 403
{ "error": "not_found" }                                  // 404
{ "error": "quota_exceeded", "quota": {...} }             // 429
{ "error": "rate_limited", "retry_after_seconds": 47 }    // 429
{ "error": "invalid_input", "issues": [...] }             // 400

Endpunkte

Scan starten

POST/api/v1/scans

Enqueues a passive scan by default. For verified domains with active authorization, paid plans can request active mode. Returns immediately with a queued scan id; poll GET /api/v1/scans/[scanId] until status === "completed".

curl -X POST https://fixvibe.app/api/v1/scans \
  -H "Authorization: Bearer fxv_..." \
  -H "content-type: application/json" \
  -d '{"target":"https://staging.example.com"}'

// 200 response

{
  "id": "8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d",
  "status": "queued",
  "target": "https://staging.example.com",
  "mode": "passive"
}

Deine Scans auflisten

GET/api/v1/scans

Gibt Scans für die Org zurück, die mit dem aufrufenden Token verbunden ist, neueste zuerst. Paginieren mit ?cursor=. Standardlimit 50, maximal 100.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/scans?limit=25"

// 200 response

{
  "scans": [
    {
      "id": "8f1c4e2a-...",
      "target_url": "https://staging.example.com",
      "target_hostname": "staging.example.com",
      "mode": "passive",
      "status": "completed",
      "started_at": "2026-05-07T14:00:00Z",
      "completed_at": "2026-05-07T14:00:23Z",
      "findings_count": { "critical": 1, "high": 3, "medium": 7, "low": 2, "info": 4 },
      "triggered_by": "api",
      "created_at": "2026-05-07T14:00:00Z"
    }
  ],
  "next_cursor": "2026-05-07T14:00:00Z:8f1c4e2a-..."
}

Scan abrufen

GET/api/v1/scans/{scanId}

Gibt standardmäßig Scan-Envelope + Severity-Zusammenfassung pro Kategorie zurück. Übergib ?include_findings=true, um den vollständigen Bericht zu erhalten (groß bei lauten Scans; bevorzuge den Findings-Endpunkt mit Filtern).

curl -H "Authorization: Bearer fxv_..." \
  https://fixvibe.app/api/v1/scans/8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d

Funde auflisten

GET/api/v1/findings

Filterbare Fundliste über alle Scans in der Org des Aufrufers. Filter: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursor-paginiert.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/findings?severity=critical,high&limit=50"

// 200 response

{
  "findings": [
    {
      "id": "...",
      "scan_id": "...",
      "check_id": "secrets.js-bundle-sweep",
      "severity": "critical",
      "title": "Supabase service role key exposed in JS bundle",
      "description": "...",
      "evidence": { ... },
      "remediation": "...",
      "cwe_id": "CWE-798",
      "created_at": "2026-05-07T14:00:23Z"
    }
  ],
  "next_cursor": null
}

OpenAPI-Spezifikation

Maschinenlesbare Spezifikation unter /docs/api/openapi (text/yaml). Wirf sie in dein bevorzugtes Codegen (openapi-typescript, openapi-python-client oder jede OpenAPI 3.1 toolchain) für typisierte Clients.

REST API — Docs · FixVibe