Dokumentácia API

Autentifikácia

Pošlite svoj API kľúč ako bearer token alebo v hlavičke X-API-Key:

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

Limity požiadaviek

120 požiadaviek za minútu na kľúč. Každá odpoveď obsahuje hlavičky X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Prekročenie limitu vráti 429 s hlavičkou Retry-After.

Spustenie skenu

POST /api/v1/scans — spustí sken na požiadanie na cieli (pridaný do vášho účtu, ak je nový). Vráti id skenu na dopytovanie.

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} — dopytujte, kým nie je done true. Vráti summary závažnosti a zoznam findings — použite ich na úspešné alebo neúspešné dokončenie 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" } ] }

Pozri DevSecOps pipeline pre úplné príklady GitLab CI a GitHub Actions, ktoré čakajú na sken a nechajú build zlyhať pri kritických nálezoch.

Pridanie cieľov (hromadne, až 1000)

POST /api/v1/targets/bulk — akceptuje domény alebo IP, voliteľne so štítkami. Rešpektuje limit cieľov vášho 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"]}]}'

Vymazanie cieľov (hromadne)

DELETE /api/v1/targets/bulk — podľa ID alebo podľa hodnôt (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"]}'

Aktualizácia štítkov (hromadne)

PATCH /api/v1/targets/tags — nastavte, pridajte alebo odoberte štítky na mnohých cieľoch naraz (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"}'

Špecifikácia OpenAPI

Úplná strojovo čitateľná špecifikácia je dostupná na /api/v1/openapi.json — naimportujte ju do Postman, Insomnia alebo svojho generátora kódu.