// 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.

Ukuqinisekisa

Isicelo ngasinye kufanele siphathe i-bearer token ku-header ye-Authorization. Ama-tokens akhishwa ku-Account → API tokens; i-plaintext iboniswa kuwe kanye kuphela uma kwakhiwa. Ukurevoke token kubuyisa 401 ku-call elandelayo.

bash

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

Ifomethi ye-token: fxv_ ilandelwa izinhlamvu ezingu-43 ze-base64url. Igcinwa at rest njenge-SHA-256 hash; i-plaintext ayigcinwa nhlobo ku-server-side.

Imikhawulo yesivinini

Amafasitela amabili kuso sonke isicelo esiqinisekisiwe: burst engu-10 req/sec kanye steady engu-60 req/min, womabili efakwe ku-bearer hash. Ukuphoqwa kwe-quota (imikhawulo yanyanga zonke yokuskena) kubekwa phezu kwalokho — bheka Ama-quota nemikhawulo.

Pagination

Ama-list endpoints (/api/v1/scans, /api/v1/findings) asebenzisa i-cursor-based pagination efakwe ku-(created_at, id) ngokwehla. Dlulisa ?cursor=<next_cursor> ukuze ufetch ikhasi elilandelayo. I-cursor ihlala ilungile ngaphansi kokubhala okuhambisanayo (akukho OFFSET skew).

Izimo zamaphutha

Lonke iphutha liyinto ye-JSON enokhiye okungenani othi 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

Qalisa ukuskena

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

Bala ukuskena kwakho

GET/api/v1/scans

Ibuyisa ukuskena kwe-org exhunywe ku-token eshayayo, okusha kakhulu kuqala. Sebenzisa pagination nge-?cursor=. Umkhawulo ojwayelekile 50, omkhulu 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-..."
}

Thola ukuskena

GET/api/v1/scans/{scanId}

Ibuyisa i-scan envelope + isifinyezo se-severity nge-category ngayinye ngokuzenzakalelayo. Dlulisa ?include_findings=true ukuze uthole umbiko ogcwele (mkhulu kuskena okunomsindo — khetha endpoint ye-findings enama-filters).

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

Bala findings

GET/api/v1/findings

Uhlu lwe-findings olungahlungwa kuzo zonke izikena ze-org yomshayeli. Filters: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Ine-cursor pagination.

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

I-spec efundeka ngomshini iku-/docs/api/openapi (text/yaml). Yifake ku-codegen oyithandayo (openapi-typescript, openapi-python-client, noma noma iyiphi i-OpenAPI 3.1 toolchain) ukuze uthole ama-clients anama-types.