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-ൽ നിന്ന് issue ചെയ്യും; plaintext creation സമയത്ത് കൃത്യമായി ഒരിക്കൽ മാത്രം കാണിക്കും. Token revoke ചെയ്താൽ അടുത്ത call-ൽ 401 return ചെയ്യും.

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 ഒരിക്കലും persist ചെയ്യില്ല.

Rate limits (നിരക്ക് പരിധികൾ)

ഓരോ authenticated request-ലും രണ്ട് windows: 10 req/sec burst and 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) descending order-ൽ (created_at, id)-ൽ keyed ആയ cursor-based pagination ഉപയോഗിക്കുന്നു. അടുത്ത page fetch ചെയ്യാൻ ?cursor=<next_cursor> pass ചെയ്യുക. Concurrent writes ഉള്ളപ്പോഴും cursor ശരിയായി തുടരും (OFFSET skew ഇല്ല).

Error shapes (പിശക് രൂപങ്ങൾ)

ഓരോ error-ും കുറഞ്ഞത് error key ഉള്ള JSON object ആണ്.

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 start ചെയ്യുക

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-നോട് ബന്ധപ്പെട്ട org-ന്റെ scans newest first ആയി return ചെയ്യും. ?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 return ചെയ്യും. Full report ലഭിക്കാൻ ?include_findings=true pass ചെയ്യുക (noisy scans-ന് വലുതായിരിക്കും — filters ഉള്ള findings endpoint ഉപയോഗിക്കുന്നത് നല്ലത്).

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-ുകളിലുമുള്ള 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 specification

Machine-readable spec /docs/api/openapi-ൽ (text/yaml). Typed clients-നായി നിങ്ങളുടെ ഇഷ്ട codegen-ലേക്ക് (openapi-typescript, openapi-python-client, അല്ലെങ്കിൽ ഏതെങ്കിലും OpenAPI 3.1 toolchain) drop ചെയ്യുക.

REST API — Docs · FixVibe