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

Awtentikazzjoni

Kull request irid iġorr bearer token fil-header Authorization. Tokens jinħarġu minn Account → API tokens; il-plaintext jintwera lilek eżatt darba mal-ħolqien. Meta tirrevoka token, is-sejħa li jmiss tirritorna 401.

bash

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

Format tat-token: fxv_ segwit minn 43 karattru base64url. Maħżun at rest bħala SHA-256 hash; il-plaintext qatt ma jiġi persisted server-side.

Limiti tar-rata

Żewġ windows fuq kull request awtentikat: 10 req/sec burst u 60 req/min steady, it-tnejn keyed fuq il-bearer hash. Quota enforcement (caps ta' scans fix-xahar) jiġi fuqhom — ara Kwoti u limiti.

Paġinazzjoni

List endpoints (/api/v1/scans, /api/v1/findings) jużaw cursor-based pagination keyed fuq (created_at, id) f'ordni descending. Għaddi ?cursor=<next_cursor> biex iġġib il-paġna li jmiss. Il-cursor jibqa' korrett taħt writes konkorrenti (l-ebda OFFSET skew).

Forom ta' żbalji

Kull żball huwa JSON object b'mill-inqas 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

Punti tat-tmiem

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

Elenka l-iscans tiegħek

GET/api/v1/scans

Jirritorna scans għall-org marbut mat-token li qed isejjaħ, l-aktar ġodda l-ewwel. Ippaginate b<code>?cursor=</code>. 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-..."
}

Ikseb scan

GET/api/v1/scans/{scanId}

Jirritorna scan envelope + summary ta' severity għal kull category b'default. Għaddi ?include_findings=true biex tikseb ir-rapport sħiħ (kbir għal scans storbjużi — ippreferi l-findings endpoint b'filters).

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

Elenka findings

GET/api/v1/findings

Lista filtrabbli ta' findings madwar kull scan fl-org tal-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 li tinqara minn magna f<openapi>/docs/api/openapi</openapi> (text/yaml). Daħħalha fil-codegen favorit tiegħek (openapi-typescript, openapi-python-client, jew kwalunkwe OpenAPI 3.1 toolchain) għal typed clients.