API dokumentacija

Autentifikacija

Pošaljite svoj API ključ kao bearer token ili u zaglavlju X-API-Key:

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

Ograničenja stope

120 zahtjeva u minuti po ključu. Svaki odgovor uključuje zaglavlja X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Prekoračenje ograničenja vraća 429 sa zaglavljem Retry-After.

Pokretanje skeniranja

POST /api/v1/scans — pokrenite skeniranje na zahtjev na cilju (dodaje se na vaš račun ako je nov). Vraća id skeniranja za polling.

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

Status i rezultati skeniranja

GET /api/v1/scans/{id} — radite polling dok done ne postane true. Vraća summary ozbiljnosti i popis findings — koristite ih za prolaz ili pad CI pipelinea.

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

Pogledajte DevSecOps pipeline za potpune primjere GitLab CI i GitHub Actions koji čekaju skeniranje i obaraju build na kritičnim nalazima.

Dodavanje ciljeva (skupno, do 1000)

POST /api/v1/targets/bulk — prihvaća domene ili IP-ove, opcionalno s oznakama. Poštuje ograničenje ciljeva vašeg plana.

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

Brisanje ciljeva (skupno)

DELETE /api/v1/targets/bulk — po ID-ovima ili po vrijednostima (IP-ovi / hostnameovi).

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

Ažuriranje oznaka (skupno)

PATCH /api/v1/targets/tags — postavite, dodajte ili uklonite oznake na više ciljeva odjednom (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 specifikacija

Potpuna strojno čitljiva specifikacija dostupna je na /api/v1/openapi.json — uvezite je u Postman, Insomnia ili svoj generator koda.