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.

Authenticatie

Elke request moet een bearer-token in de Authorization-header dragen. Tokens worden uitgegeven via Account → API tokens; de plaintext wordt precies één keer bij aanmaak aan je getoond. Een token intrekken geeft 401 bij de volgende call.

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

Tokenformaat: fxv_ gevolgd door 43 base64url-tekens. At rest opgeslagen als SHA-256-hash; de plaintext wordt server-side nooit bewaard.

Rate-limieten

Twee vensters op elke geauthenticeerde request: 10 req/sec burst en 60 req/min steady, beide keyed op de bearer-hash. Quota-afdwinging (scanlimieten per maand) komt daarbovenop — zie Quota's en limieten.

Paginering

List-endpoints (/api/v1/scans, /api/v1/findings) gebruiken cursor-based pagination op (created_at, id) in aflopende volgorde. Geef ?cursor=<next_cursor> mee om de volgende pagina op te halen. De cursor blijft correct bij gelijktijdige writes (geen OFFSET-skew).

Foutvormen

Elke fout is een JSON-object met minstens een 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

Endpoints

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

Je scans weergeven

GET/api/v1/scans

Retourneert scans voor de org die aan de calling token is gekoppeld, nieuwste eerst. Pagineer met ?cursor=. Standaardlimiet 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-..."
}

Een scan ophalen

GET/api/v1/scans/{scanId}

Retourneert standaard de scan envelope + severity-samenvatting per categorie. Geef ?include_findings=true mee voor het volledige rapport (groot bij noisy scans — gebruik liever het findings endpoint met filters).

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

Bevindingen weergeven

GET/api/v1/findings

Filterbare lijst met bevindingen over elke scan in de org van de caller. Filters: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursor-gepagineerd.

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

Machineleesbare specificatie op /docs/api/openapi (text/yaml). Stop hem in je favoriete codegen (openapi-typescript, openapi-python-client of een OpenAPI 3.1-toolchain) voor typed clients.

REST API — Docs · FixVibe