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

Fíordheimhniú

Caithfidh gach request bearer token a iompar sa header Authorization. Eisítear tokens ó Account → API tokens; taispeántar an plaintext duit go díreach uair amháin ag cruthú. Filleann revoke token 401 ar an gcéad ghlao eile.

bash

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

Formáid token: fxv_ agus 43 carachtar base64url ina dhiaidh. Stóráilte at rest mar SHA-256 hash; ní persisted an plaintext server-side riamh.

Teorainneacha ráta

Dhá fhuinneog ar gach iarratas fíordheimhnithe: 10 req/sec burst agus 60 req/min steady, iad araon eochraithe ar an bearer hash. Tagann forfheidhmiú quota (capan scanadh gach mí) ar a bharr — féach Cuótaí agus teorainneacha.

Leathanachú

Úsáideann list endpoints (/api/v1/scans, /api/v1/findings) cursor-based pagination keyed ar (created_at, id) in ord descending. Cuir ?cursor=<next_cursor> isteach chun an chéad leathanach eile a fetch. Fanann an cursor ceart faoi concurrent writes (gan OFFSET skew).

Cruthanna earráide

Is JSON object é gach earráid le key error ar a laghad.

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íochphointí

Tosaigh scanadh

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

Liostaigh do scans

GET/api/v1/scans

Filleann scans don org atá ceangailte leis an token glaonna, na cinn is nuaí ar dtús. Paginate le ?cursor=. Teorainn réamhshocraithe 50, uasmhéid 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 scanadh

GET/api/v1/scans/{scanId}

Filleann scan envelope + summary severity in aghaidh category de réir default. Cuir ?include_findings=true isteach chun an tuairisc iomlán a fháil (mór do 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

Liostaigh findings

GET/api/v1/findings

Liosta findings in-scagtha ar fud gach scanadh in org an 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 inléite ag meaisín ag /docs/api/openapi (text/yaml). Cuir isteach i do codegen is fearr leat é (openapi-typescript, openapi-python-client, nó aon OpenAPI 3.1 toolchain) le haghaidh typed clients.