Dokumentace API

Autentizace

Odešlete svůj API klíč jako bearer token nebo v hlavičce X-API-Key:

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

Limity rychlosti

120 požadavků za minutu na klíč. Každá odpověď obsahuje hlavičky X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Překročení limitu vrací 429 s hlavičkou Retry-After.

Spuštění skenu

POST /api/v1/scans — spustí sken na vyžádání na cíli (přidaném do vašeho účtu, pokud je nový). Vrací id skenu k dotazování.

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

Stav a výsledky skenu

GET /api/v1/scans/{id} — dotazujte se, dokud done není true. Vrací summary závažnosti a seznam findings — použijte je k propuštění nebo zamítnutí CI pipeline.

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

Pro úplné příklady GitLab CI a GitHub Actions, které čekají na sken a zamítnou build při kritických nálezech, viz DevSecOps pipeline.

Přidání cílů (hromadně, až 1000)

POST /api/v1/targets/bulk — přijímá domény nebo IP, volitelně se značkami. Respektuje limit cílů vašeho plánu.

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

Smazání cílů (hromadně)

DELETE /api/v1/targets/bulk — podle ID nebo podle hodnot (IP / hostname).

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

Aktualizace značek (hromadně)

PATCH /api/v1/targets/tags — nastavte, přidejte nebo odeberte značky na mnoha cílech najednou (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 specifikace

Úplná strojově čitelná specifikace je k dispozici na /api/v1/openapi.json — importujte ji do Postman, Insomnia nebo svého generátoru kódu.