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.

Authentication

Ҳар request бояд bearer token-ро дар header-и Authorization дошта бошад. Token-ҳо аз Account → API tokens issued мешаванд; plaintext ҳангоми creation ба шумо танҳо як бор нишон дода мешавад. Revoking token дар call-и баъдӣ 401 медиҳад.

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

Формати token: fxv_ ва пас аз он 43 character-и base64url. Дар rest ҳамчун hash-и SHA-256 нигоҳ дошта мешавад; plaintext ҳеҷ гоҳ server-side persist намешавад.

Rate limits

Ду window дар ҳар authenticated request: burst-и 10 req/sec ва steady-и 60 req/min, ҳар ду бо bearer hash keyed мешаванд. Quota enforcement (сарҳадҳои scan-и ҳар моҳ) болояш layer мешавад — нигаред Quotas & limits.

Pagination

List endpoints (/api/v1/scans, /api/v1/findings) cursor-based pagination-ро истифода мебаранд, ки бо (created_at, id) дар descending order keyed аст. ?cursor=<next_cursor>-ро pass кунед, то page-и баъдиро fetch кунед. Cursor зери concurrent writes дуруст мемонад (бе OFFSET skew).

Шаклҳои хатогӣ

Ҳар error як JSON object аст, ки ҳадди ақал key-и 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

Endpoints

Сканро оғоз кунед

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

Scan-ҳои худро рӯйхат кунед

GET/api/v1/scans

Scan-ҳоро барои org-е, ки ба calling token tied аст, newest first бармегардонад. Бо ?cursor= paginate кунед. 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-..."
}

Сканро гиред

GET/api/v1/scans/{scanId}

Бо default scan envelope + per-category severity summary-ро бармегардонад. ?include_findings=true-ро pass кунед, то full report-ро гиред (барои noisy scans калон аст — findings endpoint-ро бо filters бартарӣ диҳед).

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

Finding-ҳоро рӯйхат кунед

GET/api/v1/findings

Рӯйхати filterable findings дар тамоми scan-ҳои org-и caller. 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

Spec-и machine-readable дар /docs/api/openapi (text/yaml). Онро ба codegen-и дӯстдоштаи худ (openapi-typescript, openapi-python-client ё ҳар toolchain-и OpenAPI 3.1) гузоред, то clients-и typed гиред.

REST API — Docs · FixVibe