Dokumentacja API

Uwierzytelnianie

Wyślij swój klucz API jako token bearer lub w nagłówku X-API-Key:

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

Limity zapytań

120 zapytań na minutę na klucz. Każda odpowiedź zawiera nagłówki X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Przekroczenie limitu zwraca 429 z nagłówkiem Retry-After.

Uruchom skan

POST /api/v1/scans — uruchamia skan na żądanie dla celu (dodawanego do Twojego konta, jeśli jest nowy). Zwraca id skanu do odpytywania.

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

Status i wyniki skanu

GET /api/v1/scans/{id} — odpytuj, aż done będzie true. Zwraca summary według istotności oraz listę findings — użyj ich, aby przepuścić lub odrzucić pipeline CI.

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

Zobacz Pipeline DevSecOps, aby uzyskać pełne przykłady GitLab CI i GitHub Actions, które czekają na skan i przerywają build przy krytycznych wynikach.

Dodaj cele (masowo, do 1000)

POST /api/v1/targets/bulk — przyjmuje domeny lub adresy IP, opcjonalnie z tagami. Respektuje limit celów Twojego planu.

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

Usuń cele (masowo)

DELETE /api/v1/targets/bulk — według ID lub według wartości (adresy IP / nazwy hostów).

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

Aktualizuj tagi (masowo)

PATCH /api/v1/targets/tags — ustaw, dodaj lub usuń tagi na wielu celach jednocześnie (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"}'

Specyfikacja OpenAPI

Pełna specyfikacja do odczytu maszynowego jest dostępna pod adresem /api/v1/openapi.json — zaimportuj ją do Postman, Insomnia lub swojego generatora kodu.