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 — приема домейни или IP, по избор с тагове. Спазва лимита за цели на вашия план.

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 — по ID или по стойности (IP / имена на хостове).

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 или вашия кодов генератор.