// 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 ヘッダーに Bearer トークンを含める必要があります。トークンは Account → API tokens から発行します。平文は作成時に一度だけ正確に表示されます。トークンを失効させると、次回の呼び出しは 401 を返します。

bash

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

トークン形式: fxv_ に続く43文字の base64url 文字列です。保存時は SHA-256 ハッシュとして保管され、平文はサーバー側で永続化されません。

レート制限

すべての認証済みリクエストには2つのウィンドウがあります。10 req/sec のバーストと 60 req/min の定常制限で、どちらも Bearer ハッシュをキーにします。クォータ強制（毎月のスキャン上限）はその上に重なります。詳しくはクォータと制限を参照してください。

ページネーション

一覧エンドポイント（/api/v1/scans、/api/v1/findings）は、降順の (created_at, id) をキーにしたカーソルベースページネーションを使います。次のページを取得するには ?cursor=<next_cursor> を渡します。カーソルは同時書き込みがあっても正しく動作します（OFFSET のずれはありません）。

エラー形式

すべてのエラーは、少なくとも error キーを持つ JSON オブジェクトです。

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 response

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

{
  "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 を渡します（ノイズの多いスキャンでは大きくなるため、フィルター付きの findings エンドポイントを推奨します）。

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 response

{
  "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 ツールチェーン）に読み込ませてください。