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.

Նույնականացում

Յուրաքանչյուր request պետք է bearer token ունենա Authorization header-ում։ Tokens-ը թողարկվում է Account → API tokens-ից. plaintext-ը creation-ի պահին ցուցադրվում է հենց մեկ անգամ։ Token revoke անելուց հետո հաջորդ call-ը վերադարձնում է 401։

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

Token format՝ fxv_, որին հետևում է 43 base64url characters։ Stored at rest որպես SHA-256 hash. plaintext-ը երբեք server-side չի պահպանվում։

Արագության սահմանաչափեր

Յուրաքանչյուր authenticated request-ի վրա երկու windows կա՝ 10 req/sec burst և 60 req/min steady, երկուսն էլ keyed են bearer hash-ով։ Quota enforcement-ը (ամսական scan caps) շերտավորվում է վերևից՝ տես Քվոտաներ և սահմանաչափեր։

Էջավորում

List endpoints-ը (/api/v1/scans, /api/v1/findings) օգտագործում է cursor-based pagination՝ keyed on (created_at, id) descending order-ով։ Փոխանցեք ?cursor=<next_cursor> հաջորդ էջը fetch անելու համար։ Cursor-ը ճիշտ է մնում concurrent writes-ի պայմաններում (OFFSET skew չկա)։

Սխալի ձևաչափեր

Յուրաքանչյուր error JSON object է առնվազն error key-ով։

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

Վերջնակետեր

Սկսել սկան

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

Ցուցադրել ձեր սկանները

GET/api/v1/scans

Վերադարձնում է calling token-ին կապված org-ի scans-ը՝ newest first։ Paginate արեք ?cursor=-ով։ 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}

Լռելյայն վերադարձնում է scan envelope + per-category severity summary։ Փոխանցեք ?include_findings=true ամբողջ report-ը ստանալու համար (noisy scans-ի համար մեծ է. նախընտրեք findings endpoint-ը filters-ով)։

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

Ցուցադրել findings

GET/api/v1/findings

Filterable findings list caller-ի org-ի բոլոր scans-ում։ 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-ում է (text/yaml)։ Տեղադրեք ձեր նախընտրած codegen-ում (openapi-typescript, openapi-python-client կամ ցանկացած OpenAPI 3.1 toolchain) typed clients-ի համար։

REST API — Docs · FixVibe