FixWeb

// docs / rest api

REST API

Bearer-authenticated JSON API for passive scan automation, scan status, and findings. Cursor-paginated, rate-limited, and shipped with a machine-readable OpenAPI spec for client codegen. Active scans stay in the dashboard UI for ownership attestation.

प्रमाणीकरण

हर request मध्ये Authorization header मध्ये bearer token होना चाहिए। Tokens Account → API tokens से issue होते आहेत; plaintext creation पर तुम्हाला ठीक एक बार दिखता है। Token revoke करने पर next call मध्ये 401 लौटता है।

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

Token format: fxw_ के बाद 43 base64url characters। At rest SHA-256 hash के रूप मध्ये stored; plaintext server-side कभी persist नाही होता।

दर मर्यादा

हर authenticated request पर दो windows: 10 req/sec burst आणि 60 req/min steady, दोनों bearer hash पर keyed। Quota enforcement (per-month scan caps) इसके ऊपर layer होता आहे — कोटा आणि मर्यादा देखें।

पृष्ठांकन

List endpoints (/api/v1/scans, /api/v1/findings) descending order मध्ये (created_at, id) पर keyed cursor-based pagination इस्तेमाल करते हैं। अगला page fetch करने साठी ?cursor=<next_cursor> pass करें। Concurrent writes के बीच cursor सही रहता आहे (कोई OFFSET skew नाही)।

Error स्वरूप

हर 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

Endpoints

Scan शुरू करा

POST/api/v1/scans

Enqueues a passive scan. Returns immediately with a queued scan id; poll GET /api/v1/scans/[scanId] until status === "completed". Owner-depth mode is not exposed — see Scan types for the attestation-flow rationale.

curl -X POST https://fixweb.app/api/v1/scans \
  -H "Authorization: Bearer fxw_..." \
  -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"
}

अपने scans list करा

GET/api/v1/scans

Calling token से जुड़े org के scans लौटाता आहे, newest first। ?cursor= से paginate करें। Default limit 50, max 100।

curl -H "Authorization: Bearer fxw_..." \
  "https://fixweb.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-..."
}

Scan प्राप्त करा

GET/api/v1/scans/{scanId}

Default रूप से scan envelope + per-category severity summary लौटाता है। Full report पाने साठी ?include_findings=true pass करा (noisy scans मध्ये बड़ा हो सकता आहे — filters सोबत findings endpoint prefer करा)।

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

Findings list करा

GET/api/v1/findings

Filterable findings list across every scan in the caller's org. Filters: severity=critical,high, check_id=performance.delivery, since=2026-04-01T00:00:00Z. Cursor-paginated.

curl -H "Authorization: Bearer fxw_..." \
  "https://fixweb.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 तपशील

Machine-readable spec /docs/api/openapi (text/yaml) वर आहे। Typed clients साठी इसे अपने पसंदीदा codegen (openapi-typescript, openapi-python-client, या कोई भी OpenAPI 3.1 toolchain) मध्ये drop करें।

REST API — Docs · FixWeb