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.

Uwierzytelnianie

Każde żądanie musi nieść token bearer w nagłówku Authorization. Tokeny wydaje się w Konto → Tokeny API; wartość jawna jest pokazywana dokładnie raz przy tworzeniu. Unieważnienie tokenu zwraca 401 przy następnym wywołaniu.

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

Format tokenu: fxv_ plus 43 znaki base64url. W spoczynku przechowywany jako hash SHA-256; wartość jawna nigdy nie jest utrwalana po stronie serwera.

Limity zapytań

Dwa okna na każdym uwierzytelnionym żądaniu: burst 10 żądań/s i steady 60 żądań/min, oba kluczowane hashem tokenu bearer. Egzekwowanie limitów (miesięczne limity skanów) nakłada się na to — zobacz Limity i ograniczenia.

Stronicowanie

Endpointy listujące (/api/v1/scans, /api/v1/findings) używają stronicowania kursorowego opartego o (created_at, id) w kolejności malejącej. Przekaż ?cursor=<next_cursor>, aby pobrać następną stronę. Kursor pozostaje poprawny przy równoległych zapisach (brak przesunięcia OFFSET).

Formaty błędów

Każdy błąd jest obiektem JSON z co najmniej kluczem 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

Rozpocznij skan

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

// odpowiedź 200

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

Lista Twoich skanów

GET/api/v1/scans

Zwraca skany organizacji powiązanej z wywołującym tokenem, najnowsze pierwsze. Stronicuj przez ?cursor=. Domyślny limit 50, maks. 100.

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

// odpowiedź 200

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

Pobierz skan

GET/api/v1/scans/{scanId}

Domyślnie zwraca kopertę skanu + podsumowanie istotności per kategoria. Przekaż ?include_findings=true, aby dostać pełny raport (duży przy głośnych skanach — lepiej użyć endpointu findings z filtrami).

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

Lista znalezisk

GET/api/v1/findings

Filtrowalna lista znalezisk ze wszystkich skanów w organizacji wywołującego. Filtry: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Stronicowana kursorowo.

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

// odpowiedź 200

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

Specyfikacja OpenAPI

Specyfikacja czytelna maszynowo jest pod /docs/api/openapi (text/yaml). Wrzuć ją do ulubionego codegena (openapi-typescript, openapi-python-client albo dowolny toolchain OpenAPI 3.1), aby dostać typowanych klientów.

REST API — Docs · FixVibe