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.

Kimlik doğrulama

Her request Authorization header'ında bearer token taşımalıdır. Token'lar Hesap → API tokens bölümünden verilir; plaintext oluşturma sırasında sana tam olarak bir kez gösterilir. Bir token'ı iptal etmek sonraki çağrıda 401 döndürür.

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

Token formatı: fxv_ ve ardından 43 base64url karakter. Dinlenirken SHA-256 hash olarak saklanır; plaintext server-side asla kalıcı tutulmaz.

Hız limitleri

Her authenticated request'te iki pencere vardır: 10 req/sec burst ve 60 req/min steady, ikisi de bearer hash'e bağlıdır. Kota uygulaması (aylık tarama sınırları) bunun üstüne katmanlanır — bkz. Kotalar ve limitler.

Sayfalama

List endpoint'leri (/api/v1/scans, /api/v1/findings) azalan sırada (created_at, id) anahtarlı cursor-based pagination kullanır. Sonraki sayfayı almak için ?cursor=<next_cursor> gönder. Cursor concurrent writes altında doğru kalır (OFFSET skew yok).

Hata biçimleri

Her hata en az bir error key'i içeren JSON object'tir.

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

Endpoint'ler

Bir tarama başlat

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 yanıtı

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

Taramalarını listele

GET/api/v1/scans

Çağıran token'a bağlı org için taramaları, en yeni önce olacak şekilde döndürür. ?cursor= ile sayfala. Varsayılan limit 50, maksimum 100.

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

// 200 yanıtı

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

Bir taramayı al

GET/api/v1/scans/{scanId}

Varsayılan olarak scan envelope + kategori bazlı önem özeti döndürür. Tam raporu almak için ?include_findings=true gönder (gürültülü taramalar için büyük olabilir — filtreli findings endpoint'ini tercih et).

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

Bulguları listele

GET/api/v1/findings

Çağıranın org'undaki tüm taramalar genelinde filtrelenebilir bulgu listesi. Filtreler: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursor sayfalı.

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

// 200 yanıtı

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

Makine tarafından okunabilir spec /docs/api/openapi adresinde (text/yaml). Typed client'lar için favori codegen'ine bırak (openapi-typescript, openapi-python-client veya herhangi bir OpenAPI 3.1 toolchain).

REST API — Docs · FixVibe