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 ۾ Authorization header اندر bearer token هجڻ گهرجي. Tokens Account → API tokens مان issued ٿين ٿا؛ plaintext creation تي توهان کي صرف هڪ ڀيرو ڏيکاريو ويندو. Token revoke ڪرڻ سان next call تي 401 واپس اچي ٿو.

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

Token format: fxv_ پٺيان 43 base64url characters. At rest SHA-256 hash طور stored؛ plaintext ڪڏهن به server-side persisted ناهي.

Rate limits

هر authenticated request تي ٻه windows: 10 req/sec burst ۽ 60 req/min steady، ٻئي bearer hash تي keyed. Quota enforcement (per-month scan caps) مٿان layer ٿئي ٿي — ڏسو Quotas & limits.

Pagination

List endpoints (/api/v1/scans، /api/v1/findings) cursor-based pagination استعمال ڪن ٿا جيڪو descending order ۾ (created_at, id) تي keyed آهي. Next page fetch ڪرڻ لاءِ ?cursor=<next_cursor> pass ڪريو. Cursor concurrent writes هيٺ correct رهي ٿو (OFFSET skew ناهي).

Error shapes

هر 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

Endpoints

Scan شروع ڪريو

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

پنهنجا scans list ڪريو

GET/api/v1/scans

Calling token سان tied org لاءِ scans واپس ڪري ٿو، 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-..."
}

Scan حاصل ڪريو

GET/api/v1/scans/{scanId}

Default طور scan envelope + per-category severity summary واپس ڪري ٿو. Full report لاءِ ?include_findings=true pass ڪريو (noisy scans لاءِ وڏو — filters سان findings endpoint کي prefer ڪريو).

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

Findings list ڪريو

GET/api/v1/findings

Caller جي org ۾ هر scan across 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 تي (text/yaml). Typed clients لاءِ پنهنجي favourite codegen ۾ drop ڪريو (openapi-typescript، openapi-python-client، يا ڪو به OpenAPI 3.1 toolchain).

REST API — Docs · FixVibe