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

Tabbatarwa

Kowane request dole ya ɗauki bearer token a header Authorization. Ana bayar da tokens daga Account → API tokens; ana nuna plaintext gare ka daidai sau ɗaya lokacin ƙirƙira. Soke token yana dawo da 401 a kira na gaba.

bash

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

Tsarin token: fxv_ sai characters 43 na base64url. Ana adana shi a huta a matsayin SHA-256 hash; plaintext ba a taɓa adanawa a server-side ba.

Iyakokin rate

Window biyu a kan kowane authenticated request: 10 req/sec burst da 60 req/min steady, duka bisa bearer hash. Tilasta quota (iyakar scans na kowane wata) yana kan sama; duba Kaso da iyaka.

Paginering

List endpoints (/api/v1/scans, /api/v1/findings) suna amfani da cursor-based pagination da aka key a kan (created_at, id) a descending order. Tura ?cursor=<next_cursor> don fetch shafi na gaba. Cursor yana zama daidai a ƙarƙashin concurrent writes (babu OFFSET skew).

Siffofin kuskure

Kowane kuskure JSON object ne da ke da aƙalla 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

Endpoints na API

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

// amsar 200

{
  "id": "8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d",
  "status": "queued",
  "target": "https://staging.example.com",
  "mode": "passive"
}

Jera scans ɗinka

GET/api/v1/scans

Yana dawo da scans na org da ke da alaƙa da token mai kira, sabo na farko. Yi pagination da ?cursor=. Default limit 50, max 100.

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

// amsar 200

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

Samo scan

GET/api/v1/scans/{scanId}

Yana dawo da scan envelope + severity summary per category ta default. Tura ?include_findings=true don samun cikakken rahoto (babba ga scans masu hayaniya; fi son findings endpoint tare da filters).

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

Jera findings

GET/api/v1/findings

Jerin findings mai filter a kan kowane scan a org na mai kira. 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"

// amsar 200

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

Spec mai karantuwar inji a /docs/api/openapi (text/yaml). Saka cikin codegen da kake so (openapi-typescript, openapi-python-client, ko duk wani OpenAPI 3.1 toolchain) don typed clients.