API-dokumentáció

Hitelesítés

Küldje el API-kulcsát bearer tokenként vagy az X-API-Key fejlécben:

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

Sebességkorlátok

Kulcsonként percenként 120 kérés. Minden válasz tartalmazza az X-RateLimit-Limit, X-RateLimit-Remaining és X-RateLimit-Reset fejléceket. A korlát túllépése 429 választ ad egy Retry-After fejléccel.

Vizsgálat indítása

POST /api/v1/scans — igény szerinti vizsgálat indítása egy célponton (új célpont esetén hozzáadva a fiókjához). Lekérdezéshez egy vizsgálati id azonosítót ad vissza.

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

Vizsgálat állapota és eredményei

GET /api/v1/scans/{id} — kérdezze le, amíg a done igaz nem lesz. Egy súlyossági summary összegzést és a findings megállapítások listáját adja vissza — ezekkel egy CI pipeline átengedhető vagy elbuktatható.

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

Teljes GitLab CI és GitHub Actions példákért, amelyek megvárják a vizsgálatot és kritikus megállapítás esetén elbuktatják a buildet, lásd: DevSecOps pipeline.

Célpontok hozzáadása (tömegesen, akár 1000)

POST /api/v1/targets/bulk — domaineket vagy IP-ket fogad, opcionálisan címkékkel. Tiszteletben tartja a csomagja célpontkorlátját.

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

Célpontok törlése (tömegesen)

DELETE /api/v1/targets/bulk — azonosítók vagy értékek (IP-k / hosztnevek) szerint.

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

Címkék frissítése (tömegesen)

PATCH /api/v1/targets/tags — címkék beállítása, hozzáadása vagy eltávolítása több célponton egyszerre (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 specifikáció

A teljes, géppel olvasható specifikáció elérhető itt: /api/v1/openapi.json — importálja a Postmanbe, az Insomniába vagy a kódgenerátorába.