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.

Autentifikasiya

Hər request Authorization header-də bearer token daşımalıdır. Tokens Account → API tokens-dən verilir; plaintext creation zamanı sizə dəqiq bir dəfə göstərilir. Token-i revoke etmək növbəti call-da 401 qaytarır.

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

Token format: fxv_ və ardınca 43 base64url characters. Stored at rest SHA-256 hash kimi; plaintext heç vaxt server-side saxlanmır.

Sürət limitləri

Hər authenticated request-də iki windows var: 10 req/sec burst və 60 req/min steady, hər ikisi bearer hash üzrə keyed. Quota enforcement (per-month scan caps) bunun üstünə əlavə olunur — baxın Kvotalar və limitlər.

Səhifələmə

List endpoints (/api/v1/scans, /api/v1/findings) cursor-based pagination istifadə edir, (created_at, id) üzrə descending order ilə keyed. Növbəti səhifəni fetch etmək üçün ?cursor=<next_cursor> ötürün. Cursor concurrent writes altında da doğru qalır (OFFSET skew yoxdur).

Xəta formaları

Hər error ən azı error key-i olan JSON object-dir.

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

Skan 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 response

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

Skanlarınızı siyahılayın

GET/api/v1/scans

Calling token-ə bağlı org üçün scans qaytarır, newest first. ?cursor= ilə paginate edin. Default limit 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-..."
}

Skanı götür

GET/api/v1/scans/{scanId}

Default olaraq scan envelope + per-category severity summary qaytarır. Tam report üçün ?include_findings=true ötürün (noisy scans üçün böyükdür — filters ilə findings endpoint daha yaxşıdır).

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

Findings siyahısı

GET/api/v1/findings

Caller-in org-dakı bütün scan-lar üzrə filterable findings list. Filters: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursor-paginated.

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 spec

Machine-readable spec /docs/api/openapi ünvanındadır (text/yaml). Typed clients üçün sevdiyiniz codegen-ə atın (openapi-typescript, openapi-python-client və ya istənilən OpenAPI 3.1 toolchain).

REST API — Docs · FixVibe