נקודות קצה
זהו קטלוג של נקודות הקצה שמפתח או משלב משתמש בהן לרוב. כל נתיב זמין גם ללא קידומת (/scans) וגם תחת קידומת גרסה (/api/v1/scans). הבקשות והתגובות הן JSON אלא אם צוין אחרת; חלק מנקודות הקצה של הדוחות מחזירות קבצים בינריים.
בריאות ומטריקות (ציבורי)
Section titled “בריאות ומטריקות (ציבורי)”| מתודה | נתיב | מטרה |
|---|---|---|
| GET | /health | Liveness בסיסי |
| GET | /health?deep=true | אבחון רכיבים (DB, דיסק, gcloud, עמדה) |
| GET | /metrics | מטריקות Prometheus |
| GET | /api/versions | מידע גרסת API |
| מתודה | נתיב | מטרה |
|---|---|---|
| POST | /auth/login | התחברות אימייל/סיסמה (+ TOTP אופציונלי) |
| POST | /auth/refresh | רענון טוקנים |
| GET | /auth/me | המשתמש הנוכחי |
| POST | /auth/switch-tenant | הנפקת טוקן ל-Tenant אחר |
סריקות
Section titled “סריקות”| מתודה | נתיב | מטרה |
|---|---|---|
| GET | /scans | רשימת סריקות (תחומות ל-Tenant) |
| POST | /scans | התחלת סריקה (202; מכבד Idempotency-Key) |
| POST | /scans/{gcp|aws|azure|m365|workspace} | משגרים ייעודיים לספק |
| GET | /scans/{id} | סטטוס סריקה |
| POST | /scans/{id}/cancel · /resume | בקרת סריקה |
| GET | /scans/{id}/summary · /findings | תוצאות |
| GET | /checks · /profiles · /capabilities | קטלוג בדיקות, פרופילים, יכולות |
| POST | /preflight | בדיקת הרשאות טרום-סריקה |
דוחות וייצוא סריקה
Section titled “דוחות וייצוא סריקה”| מתודה | נתיב | מטרה |
|---|---|---|
| GET | /scans/{id}/report · /report/ccpr | דוחות (CCPR = עברי דו-לשוני) |
| GET | /scans/{id}/export/{excel|docx|csv|sarif|jsonlines} | ייצוא ממצאים |
| GET | /scans/{id}/audit/report/{en|he} | דוח ביקורת (אנגלית / עברית) |
ניהול ממצאים
Section titled “ניהול ממצאים”| מתודה | נתיב | מטרה |
|---|---|---|
| POST | /findings/{id}/status | עדכון סטטוס ממצא |
| POST | /findings/{id}/acknowledge | אישור קבלת ממצא |
| POST | /findings/mute · /mute/bulk | השתקת ממצאים |
| POST | /findings/{id}/revalidate | אימות-מחדש של ממצא |
| GET | /findings/delta | מה השתנה בין סריקות |
חשבונות ענן
Section titled “חשבונות ענן”| מתודה | נתיב | מטרה |
|---|---|---|
| GET | /cloud/accounts | רשימת חשבונות מחוברים |
| POST | /cloud/connect · /connect/aws · /connect/azure | חיבור ספק |
| POST | /cloud/test-credentials | אימות אישורים |
רישיון, scheduler, pentest, AI
Section titled “רישיון, scheduler, pentest, AI”| מתודה | נתיב | מטרה |
|---|---|---|
| GET | /license/status | סטטוס רישיון (ציבורי) |
| POST | /scheduler/start · /scheduler/schedules | בקרת Scheduler / תזמונים |
| POST | /pentest/orchestrate | השקת בדיקת חדירה מתוזמרת |
| POST | /ai/chat/stream | עוזר AI (דורש chat.use) |
| מתודה | נתיב | מטרה |
|---|---|---|
| GET/POST | /admin/users · /admin/roles | ניהול משתמשים / תפקידים (admin.*) |
| GET/POST | /admin/api-keys | ניהול מפתחות API |
| GET | /admin/audit-logs | יומן ביקורת (audit.view) |
| GET/POST | /api/tenants/ | ניהול Tenants |
הערות ומגבלות
Section titled “הערות ומגבלות”- הקטלוג מדגיש נקודות קצה נפוצות; הפלטפורמה חושפת רבות נוספות (ASPM, IaC, secrets, SBOM, קונטיינרים, FinOps, תאימות ועוד).
- אימות, הרשאות, MFA ושערי תכונת-רישיון חלים לפי אימות ו-הרשאות והיקפים.
- מגבלות קצב חלות — ראו מגבלות קצב.