Τεκμηρίωση 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 σάρωσης για polling.

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} — κάντε polling μέχρι το done να γίνει true. Επιστρέφει μια summary σοβαρότητας και τη λίστα των findings — χρησιμοποιήστε τα για να περάσετε ή να αποτύχετε ένα CI pipeline.

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 pipeline για πλήρη παραδείγματα GitLab CI και GitHub Actions που περιμένουν τη σάρωση και αποτυγχάνουν το build σε κρίσιμα ευρήματα.

Προσθήκη στόχων (μαζικά, έως 1000)

POST /api/v1/targets/bulk — δέχεται domains ή IP, προαιρετικά με tags. Σέβεται το όριο στόχων του πλάνου σας.

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 ή με τιμές (IP / hostnames).

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

Ενημέρωση tags (μαζικά)

PATCH /api/v1/targets/tags — ορίστε, προσθέστε ή αφαιρέστε 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 ή στον code generator σας.