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 токен у Authorization заглављу. Токени се издају из Налог → API токени; plaintext се приказује тачно једном при креирању. Опозив токена враћа 401 на следећем позиву.

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

Формат токена: fxv_ праћен са 43 base64url знака. У мировању се чува као SHA-256 hash; plaintext се никад не чува на серверу.

Ограничења брзине

Два прозора на сваком аутентификованом захтеву: burst од 10 req/sec и steady од 60 req/min, оба везана за bearer hash. Спровођење квоте (месечна ограничења скенирања) слаже се преко тога - погледајте Квоте и ограничења.

Пагинација

List endpoint-и (/api/v1/scans, /api/v1/findings) користе пагинацију засновану на курсору, кључану на (created_at, id) у опадајућем редоследу. Проследите ?cursor=<next_cursor> да дохватите следећу страницу. Курсор остаје тачан под конкурентним уписима (без OFFSET померања).

Облици грешака

Свака грешка је JSON објекат са најмање кључем 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 везан за позивајући токен, најновија прво. Пагинирајте са ?cursor=. Подразумевано ограничење 50, максимум 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 за пун извештај (велики за бучна скенирања - радије користите endpoint налаза са филтерима).

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

Листа налаза

GET/api/v1/findings

Филтрирајућа листа налаза кроз сва скенирања у org-у позиваоца. Филтери: 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 спецификација

Машински читљива спецификација на /docs/api/openapi (text/yaml). Убаците је у омиљени codegen (openapi-typescript, openapi-python-client или било који OpenAPI 3.1 toolchain) за типизоване клијенте.

REST API — Docs · FixVibe