API-dokumentaatio

Todennus

Lähetä API-avaimesi bearer-tunnuksena tai X-API-Key-otsakkeessa:

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

Käyttörajoitukset

120 pyyntöä minuutissa avainta kohden. Jokainen vastaus sisältää X-RateLimit-Limit-, X-RateLimit-Remaining- ja X-RateLimit-Reset-otsakkeet. Rajan ylittäminen palauttaa 429-koodin Retry-After-otsakkeen kanssa.

Aloita skannaus

POST /api/v1/scans — aloita pyynnöstä skannaus kohteessa (lisätään tilillesi, jos uusi). Palauttaa skannauksen id:n kyselyä varten.

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

Skannauksen tila ja tulokset

GET /api/v1/scans/{id} — kysele, kunnes done on tosi. Palauttaa vakavuussummary:n ja findings-luettelon — käytä niitä CI-putken läpäisyyn tai hylkäykseen.

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

Katso DevSecOps-putki saadaksesi täydelliset GitLab CI- ja GitHub Actions -esimerkit, jotka odottavat skannausta ja hylkäävät koonnin kriittisten löydösten perusteella.

Lisää kohteita (joukkona, enintään 1000)

POST /api/v1/targets/bulk — hyväksyy verkkotunnuksia tai IP-osoitteita, valinnaisesti tageilla. Noudattaa pakettisi kohderajaa.

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

Poista kohteita (joukkona)

DELETE /api/v1/targets/bulk — ID:n tai arvojen (IP:t / isäntänimet) perusteella.

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

Päivitä tageja (joukkona)

PATCH /api/v1/targets/tags — aseta, lisää tai poista tageja monille kohteille kerralla (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-määrittely

Täydellinen koneluettava määrittely on saatavilla osoitteessa /api/v1/openapi.json — tuo se Postmaniin, Insomniaan tai koodigeneraattoriisi.