Ana içeriğe geç

API Referansi (Calisan Ozet)

Kapsam​

Bu sayfa POC ve ilk entegrasyon icin pratik endpoint haritasidir.

Auth Endpoint'leri​

  • POST /api/v1/auth/login
  • POST /api/v1/auth/refresh
  • POST /api/v1/auth/logout
  • GET /api/v1/auth/sessions
  • DELETE /api/v1/auth/sessions/{id}

Scan Endpoint'leri​

  • POST /api/v1/orgs/{org_id}/scans
  • GET /api/v1/orgs/{org_id}/scans
  • GET /api/v1/orgs/{org_id}/scans/{id}
  • PATCH /api/v1/orgs/{org_id}/scans/{id}
  • POST /api/v1/orgs/{org_id}/scans/{id}/cancel
  • GET /api/v1/orgs/{org_id}/scans/{id}/stats
  • GET /api/v1/orgs/{org_id}/scans/{id}/findings

Report Endpoint'leri​

  • POST /api/v1/orgs/{org_id}/reports
  • GET /api/v1/orgs/{org_id}/reports
  • GET /api/v1/orgs/{org_id}/reports/{id}
  • GET /api/v1/orgs/{org_id}/reports/{id}/download
  • GET /api/v1/orgs/{org_id}/reports/{id}/stream

System Endpoint'leri​

  • GET /healthz (canlılık)
  • GET /readyz (hazırlık)
  • GET /api/v1/platform/health/detailed (ayrıntılı, kimlik doğrulama gerektirir)
  • GET /api/v1/system/state

Diğer Entegrasyon Endpoint'leri​

  • GET /api/v1/stream (gerçek zamanlı güncellemeler, SSE)
  • GET /api/v1/orgs/{org_id}/assets
  • GET /api/v1/orgs/{org_id}/vulnerabilities
  • /api/v1/orgs/{org_id}/scan-schedules
  • /api/v1/orgs/{org_id}/credentials
  • GET /api/v1/audit-logs/export

Istek Notlari​

  • Tarama oluşturmak için target ve scan_type zorunludur. Geçerli scan_type değerleri: discovery, network, vulnerability.
  • Rapor oluşturmak için name, template_type, format zorunludur. Raporlar PDF olarak üretilir.
  • Org-scope endpoint'ler gecerli org uyeligi gerektirir.

Sonraki Adim​

Ilk entegrasyon kosusu icin bu sayfayi Quick Start ile birlikte kullan.