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.

Authentifikatioun

All Request muss e Bearer-Token am Authorization-Header droen. Tokenen ginn iwwer Account → API tokens ausgestallt; de Plaintext gëtt Iech exakt eemol beim Erstelle gewisen. E réckgängeg gemaachten Token gëtt beim nächste Call 401 zeréck.

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

Tokenformat: fxv_ gefollegt vu 43 base64url-Zeechen. At rest als SHA-256-Hash gespäichert; de Plaintext gëtt ni server-säiteg persistéiert.

Rate-Limiten

Zwou Fënsteren op all authentifizéiertem Request: 10 req/sec Burst an 60 req/min Steady, allebéid op de Bearer-Hash gekeyed. Quota-Duerchsetzung (Scan-Caps pro Mount) kënnt uewendrop — kuckt Quoten & Limiten.

Paginatioun

List-Endpunkten (/api/v1/scans, /api/v1/findings) benotzen Cursor-baséiert Paginatioun, gekeyed op (created_at, id) an ofsteigender Reiefolleg. Gitt ?cursor=<next_cursor> mat fir déi nächst Säit ze lueden. De Cursor bleift bei parallele Schreiwungen korrekt (keen OFFSET-Skew).

Feelerformen

All Feeler ass e JSON-Objet mat op d'mannst engem error-Schlëssel.

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

Endpunkten

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"
}

Är Scannen oplëschten

GET/api/v1/scans

Gëtt Scanne fir d'Org zeréck, déi mam opruffenden Token verbonnen ass, déi neist fir d'éischt. Paginéiert mat ?cursor=. Standardlimit 50, max 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 kréien

GET/api/v1/scans/{scanId}

Gëtt standardméisseg Scan-Enveloppe + Severity-Zesummefaassung pro Kategorie zeréck. Gitt ?include_findings=true mat fir de komplette Rapport ze kréien (grouss bei noisy Scans — léiwer de Findings-Endpunkt mat Filtere benotzen).

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

Findings oplëschten

GET/api/v1/findings

Filterbar Findings-Lëscht iwwer all Scan an der Org vum Caller. Filteren: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursor-paginéiert.

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-Spezifikatioun

Maschinnliesbar Spec op /docs/api/openapi (text/yaml). Setzt se an Äre léifste Codegen (openapi-typescript, openapi-python-client oder all OpenAPI 3.1 Toolchain) fir typiséiert Clients.

REST API — Docs · FixVibe