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.

Autentisering

Varje request mĂ„ste bara en bearer-token i Authorization-headern. Tokens utfardas frĂ„n Konto → API-token; klartexten visas för dig exakt en gang vid skapande. Om du aterkallar en token returnerar nĂ€sta anrop 401.

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

Tokenformat: fxv_ foljt av 43 base64url-tecken. Lagras i vila som en SHA-256-hash; klartexten sparas aldrig pÄ serversidan.

Rate limits

TvÄ fönster pÄ varje autentiserad request: 10 req/sek burst och 60 req/min steady, bÄda nycklade pÄ bearer-hashen. KvottillÀmpning (skanningstak per mÄnad) lÀggs ovanpÄ - se Kvoter och grÀnser.

Paginering

List-endpoints (/api/v1/scans, /api/v1/findings) anvÀnder cursorbaserad paginering nycklad pÄ (created_at, id) i fallande ordning. Skicka ?cursor=<next_cursor> för att hÀmta nÀsta sida. Cursorn forblir korrekt vid samtidiga skrivningar (ingen OFFSET-skevhet).

Felformat

Varje fel Àr ett JSON-objekt med minst nyckeln 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

Starta en skanning

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-svar

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

Lista dina skanningar

GET/api/v1/scans

Returnerar skanningar för organisationen som Àr kopplad till anropande token, nyaste först. Paginera med ?cursor=. StandardgrÀns 50, max 100.

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

// 200-svar

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

Hamta en skanning

GET/api/v1/scans/{scanId}

Returnerar skanningskuvert + allvarlighetssammanfattning per kategori som standard. Skicka ?include_findings=true för att fÄ hela rapporten (stor för brusiga skanningar - föredra findings-endpointen med filter).

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

Lista fynd

GET/api/v1/findings

Filtrerbar fyndlista över alla skanningar i anroparens organisation. Filter: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Cursorpaginerad.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/findings?severity=critical,high&limit=50"

// 200-svar

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

MaskinlÀsbar specifikation pÄ /docs/api/openapi (text/yaml). Stoppa in den i din favorit-codegen (openapi-typescript, openapi-python-client eller valfri OpenAPI 3.1-toolchain) för typade klienter.

REST API — Docs · FixVibe