API-dokumentation

Autentisering

Skicka din API-nyckel som en bearer-token eller i rubriken X-API-Key:

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

Hastighetsbegränsningar

120 förfrågningar per minut och nyckel. Varje svar innehåller rubrikerna X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Att överskrida gränsen returnerar 429 med en Retry-After-rubrik.

Starta en skanning

POST /api/v1/scans — starta en skanning på begäran på ett mål (läggs till på ditt konto om det är nytt). Returnerar ett skannings-id att polla.

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

Skanningsstatus och resultat

GET /api/v1/scans/{id} — polla tills done är true. Returnerar en summary efter allvarlighetsgrad och listan med findings — använd dem för att godkänna eller underkänna 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 för fullständiga exempel på GitLab CI och GitHub Actions som väntar på skanningen och underkänner bygget vid kritiska fynd.

Lägg till mål (bulk, upp till 1000)

POST /api/v1/targets/bulk — accepterar domäner eller IP:er, valfritt med taggar. Respekterar din plans målgräns.

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

Ta bort mål (bulk)

DELETE /api/v1/targets/bulk — efter ID:n eller efter värden (IP:er / värdnamn).

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

Uppdatera taggar (bulk)

PATCH /api/v1/targets/tags — ange, lägg till eller ta bort taggar på många mål samtidigt (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 fullständiga maskinläsbara specifikationen finns på /api/v1/openapi.json — importera den till Postman, Insomnia eller din kodgenerator.