API dokumentacija

Autentifikavimas

Siųskite savo API raktą kaip bearer prieigos raktą arba X-API-Key antraštėje:

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

Spartos ribos

120 užklausų per minutę vienam raktui. Kiekvienas atsakymas apima X-RateLimit-Limit, X-RateLimit-Remaining ir X-RateLimit-Reset antraštes. Viršijus ribą grąžinama 429 su Retry-After antrašte.

Pradėti nuskaitymą

POST /api/v1/scans — pradėkite nuskaitymą pagal poreikį taikinyje (pridedamas prie jūsų paskyros, jei naujas). Grąžina nuskaitymo id, kurį galima apklausti.

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

Nuskaitymo būsena ir rezultatai

GET /api/v1/scans/{id} — apklauskite, kol done taps true. Grąžina rimtumo summary ir findings sąrašą — naudokite juos, kad praleistumėte arba sustabdytumėte CI konvejerį.

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

Pilnus GitLab CI ir GitHub Actions pavyzdžius, kurie laukia nuskaitymo ir sustabdo kūrimą dėl kritinių radinių, rasite DevSecOps konvejeris.

Pridėti taikinius (dideliais kiekiais, iki 1000)

POST /api/v1/targets/bulk — priima domenus arba IP, pasirinktinai su žymomis. Atsižvelgia į jūsų plano taikinių ribą.

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

Ištrinti taikinius (dideliais kiekiais)

DELETE /api/v1/targets/bulk — pagal ID arba pagal reikšmes (IP / serverių vardus).

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

Atnaujinti žymas (dideliais kiekiais)

PATCH /api/v1/targets/tags — nustatykite, pridėkite arba pašalinkite žymas daugeliui taikinių vienu metu (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

Pilna mašinai skaitoma specifikacija prieinama adresu /api/v1/openapi.json — importuokite ją į Postman, Insomnia arba savo kodo generatorių.