תיעוד API

אימות

שלחו את מפתח ה-API שלכם כ-bearer token או בכותרת X-API-Key:

curl https://vulny.app/api/v1/targets \
  -H "Authorization: Bearer vlny_your_key"

מגבלות קצב

120 בקשות לדקה למפתח. כל תגובה כוללת כותרות X-RateLimit-Limit, X-RateLimit-Remaining ו-X-RateLimit-Reset. חריגה מהמגבלה מחזירה 429 עם כותרת Retry-After.

התחלת סריקה

POST /api/v1/scans — התחילו סריקה לפי דרישה על יעד (נוסף לחשבון שלכם אם חדש). מחזיר id סריקה לתשאול.

curl -X POST https://vulny.app/api/v1/scans \
  -H "Authorization: Bearer vlny_your_key" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

# → { "id": "...", "target": "example.com", "status": "queued" }

סטטוס ותוצאות סריקה

GET /api/v1/scans/{id} — תשאלו עד ש-done הוא true. מחזיר summary חומרה ואת רשימת ה-findings — השתמשו בהם כדי להעביר או להכשיל צינור CI.

curl https://vulny.app/api/v1/scans/SCAN_ID \
  -H "Authorization: Bearer vlny_your_key"

# → { "status": "finished", "done": true, "progress": 100,
#     "summary": { "critical": 1, "high": 2, "medium": 0, "low": 3, "total": 6 },
#     "findings": [ { "severity": "critical", "title": "CVE-2024-...", "cvss_score": 9.8, "port": "443/tcp" } ] }

ראו צינור DevSecOps לדוגמאות מלאות של GitLab CI ו-GitHub Actions שממתינות לסריקה ומכשילות את הבנייה בממצאים קריטיים.

הוספת יעדים (בכמות גדולה, עד 1000)

POST /api/v1/targets/bulk — מקבל דומיינים או IPs, אופציונלית עם תגיות. מכבד את מגבלת היעדים של התוכנית שלכם.

curl -X POST https://vulny.app/api/v1/targets/bulk \
  -H "Authorization: Bearer vlny_your_key" \
  -H "Content-Type: application/json" \
  -d '{"targets":["example.com","203.0.113.10",{"value":"api.example.com","tags":["prod"]}]}'

מחיקת יעדים (בכמות גדולה)

DELETE /api/v1/targets/bulk — לפי IDs או לפי ערכים (IPs / שמות מארח).

curl -X DELETE https://vulny.app/api/v1/targets/bulk \
  -H "Authorization: Bearer vlny_your_key" \
  -H "Content-Type: application/json" \
  -d '{"values":["example.com","203.0.113.10"]}'

עדכון תגיות (בכמות גדולה)

PATCH /api/v1/targets/tags — הגדירו, הוסיפו או הסירו תגיות ביעדים רבים בבת אחת (mode: set | add | remove).

curl -X PATCH https://vulny.app/api/v1/targets/tags \
  -H "Authorization: Bearer vlny_your_key" \
  -H "Content-Type: application/json" \
  -d '{"values":["example.com"],"tags":["pci","prod"],"mode":"add"}'

מפרט OpenAPI

המפרט המלא הקריא-מכונה זמין בכתובת /api/v1/openapi.json — ייבאו אותו ל-Postman, Insomnia או למחולל הקוד שלכם.