Dokumentacija API

Overjanje

Pošljite svoj ključ API kot žeton nosilca ali v glavi X-API-Key:

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

Omejitve hitrosti

120 zahtevkov na minuto na ključ. Vsak odgovor vključuje glave X-RateLimit-Limit, X-RateLimit-Remaining in X-RateLimit-Reset. Preseganje omejitve vrne 429 z glavo Retry-After.

Zaženite pregled

POST /api/v1/scans — zaženite pregled na zahtevo na cilju (dodanem v vaš račun, če je nov). Vrne id pregleda za poizvedovanje.

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

Stanje in rezultati pregleda

GET /api/v1/scans/{id} — poizvedujte, dokler done ni true. Vrne summary resnosti in seznam findings — uporabite ju za uspeh ali neuspeh cevovoda 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" } ] }

Za popolne primere GitLab CI in GitHub Actions, ki počakajo na pregled in spodletijo gradnjo ob kritičnih ugotovitvah, glejte DevSecOps cevovod.

Dodajte cilje (množično, do 1000)

POST /api/v1/targets/bulk — sprejema domene ali IP-je, po želji z oznakami. Upošteva omejitev ciljev vašega paketa.

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

Izbrišite cilje (množično)

DELETE /api/v1/targets/bulk — po ID-jih ali po vrednostih (IP-ji / imena gostiteljev).

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

Posodobite oznake (množično)

PATCH /api/v1/targets/tags — nastavite, dodajte ali odstranite oznake na več ciljih hkrati (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"}'

Specifikacija OpenAPI

Popolna strojno berljiva specifikacija je na voljo na /api/v1/openapi.json — uvozite jo v Postman, Insomnia ali svoj generator kode.