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.

Автентифікація

Кожен request має містити bearer token у header Authorization. Tokens видаються з Account → API tokens; plaintext показується тобі рівно один раз під час створення. Відкликання token повертає 401 на наступному виклику.

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

Формат token: fxv_, після якого йдуть 43 base64url characters. У стані спокою зберігається як SHA-256 hash; plaintext ніколи не зберігається на сервері.

Обмеження швидкості

Два windows для кожного authenticated request: 10 req/sec burst і 60 req/min steady, обидва keyed на bearer hash. Застосування квот (місячні ліміти сканувань) накладається зверху — див. Квоти й ліміти.

Пагінація

List endpoints (/api/v1/scans, /api/v1/findings) використовують cursor-based pagination, keyed on (created_at, id) у descending order. Передай ?cursor=<next_cursor>, щоб отримати наступну сторінку. Cursor лишається коректним під concurrent writes (без OFFSET skew).

Форми помилок

Кожна помилка — JSON object щонайменше з 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

Кінцеві точки

Запусти сканування

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

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

Список твоїх сканувань

GET/api/v1/scans

Повертає сканування для org, прив’язаної до calling token, найновіші першими. Пагінуй через ?cursor=. Default limit 50, max 100.

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

// відповідь 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-..."
}

Отримай сканування

GET/api/v1/scans/{scanId}

За замовчуванням повертає оболонку сканування + підсумок серйозності за категоріями. Передай ?include_findings=true, щоб отримати повний звіт (великий для noisy scans — краще endpoint findings із filters).

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

Список знахідок

GET/api/v1/findings

Список знахідок із фільтрами по всіх скануваннях в org кличного token. Фільтри: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Пагінація курсором.

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

// відповідь 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 на /docs/api/openapi (text/yaml). Drop into твій улюблений codegen (openapi-typescript, openapi-python-client або будь-який OpenAPI 3.1 toolchain) для typed clients.

REST API — Docs · FixVibe