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.

인증

모든 요청은 Authorization header에 bearer token을 포함해야 합니다. Token은 계정 → API 토큰에서 발급되며, 평문은 생성 시 정확히 한 번만 표시됩니다. Token을 revoke하면 다음 호출부터 401을 반환합니다.

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

Token 형식: fxv_ 뒤에 43자의 base64url 문자가 붙습니다. 저장 시에는 SHA-256 hash로 저장되며 평문은 서버 측에 저장되지 않습니다.

Rate limit

모든 인증 요청에는 두 window가 적용됩니다. 10 req/sec burst와 60 req/min steady이며, 둘 다 bearer hash를 기준으로 합니다. Quota enforcement(월별 scan cap)는 그 위에 적용됩니다. 자세한 내용은 할당량 및 제한을 참고하세요.

Pagination

List endpoint(/api/v1/scans, /api/v1/findings)는 (created_at, id)를 기준으로 descending order cursor pagination을 사용합니다. 다음 page를 가져오려면 ?cursor=<next_cursor>를 전달하세요. Concurrent write가 있어도 cursor는 정확하게 유지됩니다(OFFSET skew 없음).

Error shape

모든 error는 최소한 error key를 가진 JSON object입니다.

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

호출 token에 연결된 org의 scan을 최신순으로 반환합니다. ?cursor=로 paginate하세요. 기본 limit은 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}

기본적으로 scan envelope와 category별 severity summary를 반환합니다. 전체 report를 받으려면 ?include_findings=true를 전달하세요(noisy scan에서는 클 수 있으므로 filter가 있는 findings endpoint를 권장합니다).

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

Finding 목록

GET/api/v1/findings

호출자의 org 안 모든 scan에 걸친 filterable findings list입니다. Filter: 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 spec

Machine-readable spec은 /docs/api/openapi(text/yaml)에 있습니다. Typed client를 만들려면 선호하는 codegen(openapi-typescript, openapi-python-client 또는 OpenAPI 3.1 toolchain)에 넣으세요.

REST API — Docs · FixVibe