API-dokumentasjon

Autentisering

Send API-nøkkelen din som en bearer-token eller i X-API-Key-hodet:

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

Hastighetsgrenser

120 forespørsler per minutt per nøkkel. Hvert svar inkluderer hodene X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Overskridelse av grensen returnerer 429 med et Retry-After-hode.

Start en skanning

POST /api/v1/scans — start en skanning på forespørsel på et mål (legges til kontoen din hvis nytt). Returnerer en skanne-id for 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" }

Skannestatus og resultater

GET /api/v1/scans/{id} — poll til done er true. Returnerer en alvorlighets-summary og listen over findings — bruk dem til å godkjenne eller avvise 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 fullstendige GitLab CI- og GitHub Actions-eksempler som venter på skanningen og lar bygget feile ved kritiske funn.

Legg til mål (bulk, opptil 1000)

POST /api/v1/targets/bulk — godtar domener eller IP-er, eventuelt med tagger. Respekterer målgrensen i planen din.

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

Slett mål (bulk)

DELETE /api/v1/targets/bulk — etter ID-er eller etter verdier (IP-er / vertsnavn).

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

Oppdater tagger (bulk)

PATCH /api/v1/targets/tags — sett, legg til eller fjern tagger på mange mål samtidig (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-spesifikasjon

Den fullstendige maskinlesbare spesifikasjonen er tilgjengelig på /api/v1/openapi.json — importer den til Postman, Insomnia eller kodegeneratoren din.