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.

Autenticació

Cada petició ha de portar un Bearer token a la capçalera Authorization. Els tokens s’emeten des de Compte → API tokens; el text pla se’t mostra exactament una vegada en crear-lo. Revocar un token retorna 401 a la crida següent.

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

Format del token: fxv_ seguit de 43 caràcters base64url. S’emmagatzema en repòs com a hash SHA-256; el text pla no es conserva mai al servidor.

Límits de taxa

Dues finestres en cada petició autenticada: ràfega de 10 req/sec i règim sostingut de 60 req/min, totes dues vinculades al hash del Bearer token. L’aplicació de quotes (topalls mensuals d’escaneig) s’hi superposa; consulta Quotes i límits.

Paginació

Els endpoints de llista (/api/v1/scans, /api/v1/findings) fan servir paginació per cursor basada en (created_at, id) en ordre descendent. Passa ?cursor=<next_cursor> per obtenir la pàgina següent. El cursor es manté correcte amb escriptures concurrents, sense desviacions d’OFFSET.

Formats d’error

Cada error és un objecte JSON amb almenys una clau 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

Punts d’entrada

Iniciar un escaneig

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

// resposta 200

{
  "id": "8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d",
  "status": "queued",
  "target": "https://staging.example.com",
  "mode": "passive"
}

Llistar els teus escaneigs

GET/api/v1/scans

Retorna els escaneigs de l’organització vinculada al token que crida, del més nou al més antic. Pagina amb ?cursor=. Límit per defecte 50, màxim 100.

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

// resposta 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-..."
}

Obtenir un escaneig

GET/api/v1/scans/{scanId}

Retorna l’envolupant de l’escaneig i el resum de severitat per categoria per defecte. Passa ?include_findings=true per obtenir l’informe complet (gran en escaneigs sorollosos; és preferible l’endpoint de troballes amb filtres).

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

Llistar troballes

GET/api/v1/findings

Llista filtrable de troballes de tots els escaneigs de l’organització que crida. Filtres: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. Paginada per cursor.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/findings?severity=critical,high&limit=50"

// resposta 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
}

Especificació OpenAPI

Especificació llegible per màquina a /docs/api/openapi (text/yaml). Introdueix-la al teu codegen preferit (openapi-typescript, openapi-python-client o qualsevol toolchain OpenAPI 3.1) per obtenir clients tipats.

REST API — Docs · FixVibe