API dokumentācija

Autentifikācija

Nosūtiet savu API atslēgu kā nesēja marķieri (bearer token) vai X-API-Key galvenē:

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

Pieprasījumu ierobežojumi

120 pieprasījumi minūtē uz vienu atslēgu. Katra atbilde iekļauj X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset galvenes. Ierobežojuma pārsniegšana atgriež 429 ar Retry-After galveni.

Sākt skenēšanu

POST /api/v1/scans — sāciet pieprasījuma skenēšanu mērķim (pievienots jūsu kontam, ja tas ir jauns). Atgriež skenēšanas id aptaujāšanai.

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

Skenēšanas statuss un rezultāti

GET /api/v1/scans/{id} — aptaujājiet, līdz done ir true. Atgriež smaguma pakāpes summary un findings sarakstu — izmantojiet tos, lai izietu vai noraidītu CI konveijeru.

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

Skatiet DevSecOps konveijeru pilniem GitLab CI un GitHub Actions piemēriem, kas gaida skenēšanu un noraida būvējumu kritisku atklājumu gadījumā.

Pievienot mērķus (lielapjomā, līdz 1000)

POST /api/v1/targets/bulk — pieņem domēnus vai IP, pēc izvēles ar tagiem. Ievēro jūsu plāna mērķu ierobežojumu.

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

Dzēst mērķus (lielapjomā)

DELETE /api/v1/targets/bulk — pēc ID vai pēc vērtībām (IP / resursdatoru nosaukumi).

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

Atjaunināt tagus (lielapjomā)

PATCH /api/v1/targets/tags — iestatiet, pievienojiet vai noņemiet tagus daudziem mērķiem vienlaikus (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ācija

Pilna mašīnlasāma specifikācija ir pieejama vietnē /api/v1/openapi.json — importējiet to Postman, Insomnia vai savā koda ģeneratorā.