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.

Piştrastkirin

Her request divê bearer tokenek di header-a Authorization de hilgire. Token ji Account → API tokens tên derxistin; plaintext di afirandinê de tenê carekê bi temamî tê nîşandan. Betalkirina token di banga paşê de 401 vedigerîne.

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

Forma tokenê: fxv_ û piştî wê 43 karakterên base64url. Di rest de wekî hash-a SHA-256 tê hilanîn; plaintext tu carî server-side nayê persist kirin.

Sînorên rêjeyê

Du pace li ser her request-a authenticated: burst-a 10 req/sec û steady-a 60 req/min, her du jî li ser bearer hash keyed in. Enforcekirina quota (sînorên scanê yên her mehê) li ser dikeve — li Quota û sînor binêre.

Rûpelkirin

Endpointên lîstekirinê (/api/v1/scans, /api/v1/findings) pagination-a cursor-based bi key-a (created_at, id) di rêza daketî de bi kar tînin. ?cursor=<next_cursor> bişîne da rûpela paşê bistînî. Cursor di bin nivîsandina hevdem de jî rast dimîne (bê skew-a OFFSET).

Şêweyên çewtiyan

Her çewtî objectek JSON e ku kêmî qada error heye.

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

Scanek dest pê bike

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"
}

Scanên xwe lîste bike

GET/api/v1/scans

Scanên org-a girêdayî token-a bangker vedigerîne, nûtirîn pêşî. Bi ?cursor= paginate bike. Sînora default 50, max 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-..."
}

Scanek bistîne

GET/api/v1/scans/{scanId}

Bi default envelope-a scan + kurtasiya severity ya her category vedigerîne. ?include_findings=true bişîne da rapora tevahî bistînî (ji bo scanên dengdar mezin e — endpoint-a findings bi filteran tercîh bike).

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

Findingan lîste bike

GET/api/v1/findings

Lîsteya findingên bi filter li ser hemû scanên di org-a bangker de. 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 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
}

Spec-a OpenAPI

Spec-a machine-readable li /docs/api/openapi (text/yaml). Bike nav codegen-a xwe ya bijarte (openapi-typescript, openapi-python-client, an her toolchain-a OpenAPI 3.1) ji bo clientên typed.

REST API — Docs · FixVibe