API-dokumentation

Autentificering

Send din API-nøgle som et bearer-token eller i X-API-Key-headeren:

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

Hastighedsgrænser

120 anmodninger pr. minut pr. nøgle. Hvert svar indeholder X-RateLimit-Limit-, X-RateLimit-Remaining- og X-RateLimit-Reset-headere. Overskridelse af grænsen returnerer 429 med en Retry-After-header.

Start en scanning

POST /api/v1/scans — start en on-demand-scanning på et mål (tilføjes til din konto, hvis det er nyt). Returnerer et scannings-id til 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" }

Scanningsstatus og resultater

GET /api/v1/scans/{id} — poll, indtil done er true. Returnerer et alvorlighedssammendrag summary og listen over fund findings — brug dem til at bestå eller dumpe en CI-pipeline.

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

Se DevSecOps-pipeline for komplette GitLab CI- og GitHub Actions-eksempler, der venter på scanningen og dumper builden ved kritiske fund.

Tilføj mål (bulk, op til 1000)

POST /api/v1/targets/bulk — accepterer domæner eller IP'er, valgfrit med tags. Respekterer din plans målgrænse.

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

Slet mål (bulk)

DELETE /api/v1/targets/bulk — efter ID'er eller efter værdier (IP'er / hostnavne).

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

Opdatér tags (bulk)

PATCH /api/v1/targets/tags — sæt, tilføj eller fjern tags på mange mål på én gang (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-specifikation

Den fulde maskinlæsbare specifikation er tilgængelig på /api/v1/openapi.json — importér den i Postman, Insomnia eller din kodegenerator.