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