API-skjölun

Auðkenning

Sendu API-lykilinn þinn sem bearer-tóka eða í X-API-Key-hausnum:

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

Hraðatakmörk

120 beiðnir á mínútu á hvern lykil. Hvert svar inniheldur hausana X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Ef farið er yfir mörkin er skilað 429 með Retry-After-haus.

Hefja skönnun

POST /api/v1/scans — hefur skönnun að beiðni á markmiði (bætt við aðganginn þinn ef nýtt). Skilar skönnunar-id til að spyrja um.

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

Staða og niðurstöður skönnunar

GET /api/v1/scans/{id} — spyrðu þar til done er satt. Skilar alvarleika-summary og lista yfir findings — notaðu þau til að láta CI-ferli standast eða falla.

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

Sjá DevSecOps-ferli fyrir fullkomin dæmi um GitLab CI og GitHub Actions sem bíða eftir skönnuninni og láta byggingu falla þegar alvarlegar niðurstöður finnast.

Bæta við markmiðum (í magni, allt að 1000)

POST /api/v1/targets/bulk — tekur við lénum eða IP, valfrjálst með merkjum (tags). Virðir markmiðatakmörk áætlunarinnar þinnar.

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

Eyða markmiðum (í magni)

DELETE /api/v1/targets/bulk — eftir auðkennum (IDs) eða eftir gildum (IP / hýsilheiti).

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

Uppfæra merki (í magni)

PATCH /api/v1/targets/tags — settu, bættu við eða fjarlægðu merki á mörgum markmiðum í einu (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-skilgreining

Full véllæsanleg skilgreining er fáanleg á /api/v1/openapi.json — flyttu hana inn í Postman, Insomnia eða kóðasmið þinn.