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.

Verifikasie

Elke versoek moet ’n bearer-token in die Authorization-koptekst dra. Tokens word uitgereik vanaf Account → API tokens; die gewone teks word presies een keer by skepping aan jou gewys. Om ’n token te herroep gee 401 op die volgende oproep.

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

Tokenformaat: fxv_ gevolg deur 43 base64url-karakters. In rus gestoor as ’n SHA-256-hash; die gewone teks word nooit server-kant gehou nie.

Tempo-limiete

Twee vensters op elke geverifieerde versoek: 10 req/sec burst en 60 req/min steady, albei gesleutel op die bearer-hash. Kwota-afdwinging (per-maand skanderingsperke) lê bo-op; sien Kwotas en limiete.

Paginering

Lys-eindpunte (/api/v1/scans, /api/v1/findings) gebruik wysergebaseerde paginering gesleutel op (created_at, id) in dalende volgorde. Gee ?cursor=<next_cursor> deur om die volgende bladsy te haal. Die wyser bly korrek onder gelyktydige skrywes (geen OFFSET-skeefheid).

Foutvorms

Elke fout is ’n JSON-objek met minstens ’n error-sleutel.

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

Eindpunte

Begin ’n skandering

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

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

Lys jou skanderings

GET/api/v1/scans

Gee skanderings terug vir die org wat aan die oproepende token gekoppel is, nuutste eerste. Pagineer met ?cursor=. Versteklimiet 50, maksimum 100.

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

// 200-antwoord

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

Kry ’n skandering

GET/api/v1/scans/{scanId}

Gee standaard die skandering-omhulsel + ernsopsomming per kategorie terug. Gee ?include_findings=true deur om die volle verslag te kry (groot vir rumoerige skanderings; verkies die bevindinge-eindpunt met filters).

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

Lys bevindinge

GET/api/v1/findings

Filtreerbare bevindingelys oor elke skandering in die oproeper se org. Filters: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Wysergepagineer.

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

// 200-antwoord

{
  "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-spesifikasie

Masjienleesbare spesifikasie by /docs/api/openapi (text/yaml). Gooi dit in jou gunsteling codegen (openapi-typescript, openapi-python-client, of enige OpenAPI 3.1-toolchain) vir getipeerde kliënte.

REST API — Docs · FixVibe