Документація API

Автентифікація

Надсилайте свій ключ API як bearer-токен або в заголовку 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 чи ваш генератор коду.