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.

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

Всяка заявка трябва да носи bearer token в header-а Authorization. Token-ите се издават от Account → API tokens; plaintext се показва точно веднъж при създаване. Отмяната на token връща 401 при следващото извикване.

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

Формат на token: fxv_, последвано от 43 base64url символа. Stored at rest като SHA-256 hash; plaintext никога не се persist-ва server-side.

Ограничения на честотата

Два прозореца за всяка автентикирана заявка: 10 req/sec burst и 60 req/min steady, и двата keyed върху bearer hash. Quota enforcement (месечни scan caps) се наслагва отгоре: виж Квоти и лимити.

Пагинация

List endpoints (/api/v1/scans, /api/v1/findings) използват cursor-based pagination върху (created_at, id) в низходящ ред. Подай ?cursor=<next_cursor>, за да fetch-неш следващата страница. Cursor-ът остава коректен при concurrent writes (без OFFSET skew).

Форми на грешки

Всяка грешка е JSON object с поне ключ 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

Endpoint-и

Стартирай сканиране

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-а, най-новите първи. Paginate с ?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}

По подразбиране връща scan envelope + severity summary по category. Подай ?include_findings=true, за да получиш пълния отчет (голям при noisy scans: предпочитай findings endpoint-а с filters).

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

Списък на откритите проблеми

GET/api/v1/findings

Filterable findings list през всички сканирания в org на caller-а. Филтри: 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 отговор

{
  "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 спецификация

Machine-readable спецификация на /docs/api/openapi (text/yaml). Пусни я в любимия си codegen (openapi-typescript, openapi-python-client или който и да е OpenAPI 3.1 toolchain) за typed clients.

REST API — Docs · FixVibe