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.

Autentifikácia

Každá požiadavka musí niesť bearer token v hlavičke Authorization. Tokeny sa vydávajú cez Account → API tokens; plaintext sa ti pri vytvorení ukáže presne raz. Odvolanie tokenu vráti pri ďalšom volaní 401.

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

Formát tokenu: fxv_ nasledované 43 base64url znakmi. V pokoji je uložený ako SHA-256 hash; plaintext sa nikdy neukladá na serveri.

Rate limity

Dve okná pri každej autentifikovanej požiadavke: burst 10 req/sec a stabilné 60 req/min, obe kľúčované podľa bearer hashu. Vynucovanie kvót (mesačné limity skenov) je vrstva nad tým, pozri Kvóty a limity.

Paginácia

List endpointy (/api/v1/scans, /api/v1/findings) používajú kurzorovú pagináciu kľúčovanú podľa (created_at, id) v zostupnom poradí. Pošli ?cursor=<next_cursor>, aby si načítal ďalšiu stránku. Kurzor ostáva správny aj pri súbežných zápisoch (bez OFFSET posunu).

Tvary chýb

Každá chyba je JSON objekt aspoň s kľúčom error.

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

Endpointy

Spusti sken

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 odpoveď

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

Vypíš svoje skeny

GET/api/v1/scans

Vráti skeny pre org naviazanú na volajúci token, najnovšie ako prvé. Paginuj cez ?cursor=. Predvolený limit je 50, maximum 100.

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

// 200 odpoveď

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

Získaj sken

GET/api/v1/scans/{scanId}

Predvolene vráti obálku skenu + súhrn závažností podľa kategórií. Pridaj ?include_findings=true, ak chceš plnú správu (pri hlučných skenoch veľká, radšej použi endpoint findings s filtrami).

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

Vypíš nálezy

GET/api/v1/findings

Filtrovateľný zoznam nálezov naprieč všetkými skenmi v org volajúceho. Filtre: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Kurzorovo paginované.

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

// 200 odpoveď

{
  "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 špecifikácia

Strojovo čitateľná špecifikácia na /docs/api/openapi (text/yaml). Vlož ju do obľúbeného codegenu (openapi-typescript, openapi-python-client alebo ľubovoľný OpenAPI 3.1 toolchain) a získaš typovaných klientov.

REST API — Docs · FixVibe