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.

Dilysu

Rhaid i bob cais gario bearer token yn y pennawd Authorization. Caiff tokens eu cyhoeddi o Account → API tokens; dangosir y plaintext i chi unwaith yn union wrth greu. Mae dirymu token yn dychwelyd 401 ar yr alwad nesaf.

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

Fformat token: fxv_ wedi'i ddilyn gan 43 nod base64url. Wedi'i storio at rest fel hash SHA-256; ni chaiff y plaintext ei gadw ar ochr y gweinydd byth.

Terfynau cyfradd

Dwy ffenestr ar bob cais wedi'i ddilysu: burst 10 req/sec a steady 60 req/min, y ddwy wedi'u keyio ar y bearer hash. Mae gorfodi cwota (capiau sgan fesul mis) yn haenu ar ben hynny; gweler Cwotâu a therfynau.

Tudalennu

Mae endpoints rhestru (/api/v1/scans, /api/v1/findings) yn defnyddio tudalennu seiliedig ar cursor wedi'i keyio ar (created_at, id) mewn trefn ddisgynnol. Pasio ?cursor=<next_cursor> i fetchio'r dudalen nesaf. Mae'r cursor yn aros yn gywir dan ysgrifennu cydamserol (dim OFFSET skew).

Siapiau gwall

Mae pob gwall yn wrthrych JSON gydag o leiaf allwedd 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

Dechrau sgan

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

Rhestru eich sganiau

GET/api/v1/scans

Yn dychwelyd sganiau ar gyfer yr org sydd ynghlwm wrth y token galw, y mwyaf newydd yn gyntaf. Tudalennwch gyda ?cursor=. Terfyn diofyn 50, uchafswm 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-..."
}

Cael sgan

GET/api/v1/scans/{scanId}

Yn dychwelyd envelope sgan + crynodeb difrifoldeb fesul categori yn ddiofyn. Pasio ?include_findings=true i gael yr adroddiad llawn (mawr ar gyfer sganiau swnllyd; gwell defnyddio'r endpoint findings gyda hidlwyr).

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

Rhestru canfyddiadau

GET/api/v1/findings

Rhestr canfyddiadau hidladwy ar draws pob sgan yn org y galwr. Hidlwyr: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Wedi'i dudalennu â cursor.

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
}

Manyleb OpenAPI

Manyleb ddarllenadwy gan beiriant yn /docs/api/openapi (text/yaml). Rhowch hi yn eich hoff codegen (openapi-typescript, openapi-python-client, neu unrhyw toolchain OpenAPI 3.1) ar gyfer cleientiaid typed.

REST API — Docs · FixVibe