API dokumentatsioon

Autentimine

Saada oma API-võti bearer-tokenina või X-API-Key päises:

curl https://vulny.app/api/v1/targets \
  -H "Authorization: Bearer vlny_your_key"

Päringupiirangud

120 päringut minutis võtme kohta. Iga vastus sisaldab päiseid X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Piirangu ületamine tagastab 429 koos Retry-After päisega.

Käivita skaneering

POST /api/v1/scans — käivita nõudmisel skaneering sihtmärgil (lisatakse sinu kontole, kui uus). Tagastab pollimiseks skaneeringu 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" }

Skaneeringu olek ja tulemused

GET /api/v1/scans/{id} — polli, kuni done on true. Tagastab raskusastme summary ja findings loendi — kasuta neid CI-konveieri läbimiseks või ebaõnnestumiseks.

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

Täielike GitLab CI ja GitHub Actions näidete kohta, mis ootavad skaneeringu lõppu ja kukutavad ehituse läbi kriitiliste leidude korral, vaata DevSecOps konveierit.

Lisa sihtmärke (hulgi, kuni 1000)

POST /api/v1/targets/bulk — aktsepteerib domeene või IP-sid, valikuliselt siltidega. Arvestab sinu paketi sihtmärgipiirangut.

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

Kustuta sihtmärke (hulgi)

DELETE /api/v1/targets/bulk — ID-de järgi või väärtuste järgi (IP-d / hostinimed).

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

Uuenda silte (hulgi)

PATCH /api/v1/targets/tags — sea, lisa või eemalda silte korraga paljudel sihtmärkidel (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 spetsifikatsioon

Täielik masinloetav spetsifikatsioon on saadaval aadressil /api/v1/openapi.json — impordi see Postmani, Insomniasse või oma koodigeneraatorisse.