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