FixVibe

// docs / rest api

API REST

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.

Dearbhadh

Feumaidh gach request bearer token a ghiùlan san header Authorization. Thèid tokens a thoirt a-mach bho Account → API tokens; thèid am plaintext a shealltainn dhut dìreach aon turas nuair a chruthaichear e. Tillidh revoke token 401 air an ath ghairm.

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

Cruth token: fxv_ air a leantainn le 43 caractar base64url. Air a stòradh at rest mar SHA-256 hash; cha tèid am plaintext a persisted server-side a-riamh.

Crìochan reata

Dà uinneag air gach iarrtas dearbhte: 10 req/sec burst agus 60 req/min steady, an dà chuid eochraichte air an bearer hash. Tha cur-an-gnìomh quota (capan scan gach mìos) air a chur os a chionn — faic Cuotathan is crìochan.

Duilleagachadh

Cleachdaidh list endpoints (/api/v1/scans, /api/v1/findings) cursor-based pagination keyed air (created_at, id) ann an òrdugh descending. Cuir ?cursor=<next_cursor> gus an ath dhuilleag a fetch. Fuirichidh an cursor ceart fo concurrent writes (gun OFFSET skew).

Cumaidhean mhearachdan

Tha gach mearachd na JSON object le co-dhiù 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

Crìoch-phuingean

Tòisich 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"
}

Liostaich na scans agad

GET/api/v1/scans

Tillidh scans airson an org ceangailte ris an token gairm, na cinn as ùire an toiseach. Paginate le ?cursor=. Crìoch bhunaiteach 50, as motha 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-..."
}

Faigh scan

GET/api/v1/scans/{scanId}

Tillidh scan envelope + summary severity gach category gu default. Cuir ?include_findings=true gus an aithisg slàn fhaighinn (mòr airson scans noisy — b'fhearr an findings endpoint le filters).

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

Liostaich findings

GET/api/v1/findings

Liosta findings filterable thar gach scan ann an org a' 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
}

Spec OpenAPI

Spec a leughas inneal aig /docs/api/openapi (text/yaml). Cuir a-steach dhan codegen as fheàrr leat (openapi-typescript, openapi-python-client, no OpenAPI 3.1 toolchain sam bith) airson typed clients.

API REST — Docs · FixVibe