API Referansi (Calisan Ozet)
Kapsam
Bu sayfa POC ve ilk entegrasyon icin pratik endpoint haritasidir.
Auth Endpoint'leri
POST /api/v1/auth/loginPOST /api/v1/auth/refreshPOST /api/v1/auth/logoutGET /api/v1/auth/sessionsDELETE /api/v1/auth/sessions/{id}
Scan Endpoint'leri
POST /api/v1/orgs/{org_id}/scansGET /api/v1/orgs/{org_id}/scansGET /api/v1/orgs/{org_id}/scans/{id}PATCH /api/v1/orgs/{org_id}/scans/{id}POST /api/v1/orgs/{org_id}/scans/{id}/cancelGET /api/v1/orgs/{org_id}/scans/{id}/statsGET /api/v1/orgs/{org_id}/scans/{id}/findings
Report Endpoint'leri
POST /api/v1/orgs/{org_id}/reportsGET /api/v1/orgs/{org_id}/reportsGET /api/v1/orgs/{org_id}/reports/{id}GET /api/v1/orgs/{org_id}/reports/{id}/downloadGET /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}/assetsGET /api/v1/orgs/{org_id}/vulnerabilities/api/v1/orgs/{org_id}/scan-schedules/api/v1/orgs/{org_id}/credentialsGET /api/v1/audit-logs/export
Istek Notlari
- Tarama oluşturmak için
targetvescan_typezorunludur. Geçerliscan_typedeğerleri:discovery,network,vulnerability. - Rapor oluşturmak için
name,template_type,formatzorunludur. 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.