API dokümantasyonu

Kimlik doğrulama

API anahtarınızı bir bearer token olarak veya X-API-Key başlığında gönderin:

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

Hız sınırları

Anahtar başına dakikada 120 istek. Her yanıt X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıklarını içerir. Sınırın aşılması, bir Retry-After başlığıyla 429 döndürür.

Bir tarama başlat

POST /api/v1/scans — bir hedefte isteğe bağlı bir tarama başlatın (yeniyse hesabınıza eklenir). Sorgulanacak bir tarama id'si döndürür.

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

Tarama durumu ve sonuçları

GET /api/v1/scans/{id} — done true olana kadar sorgulayın. Bir önem derecesi summary'si ve findings listesi döndürür — bunları bir CI pipeline'ını geçirmek veya başarısız kılmak için kullanın.

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

Taramayı bekleyen ve kritik bulgularda derlemeyi başarısız kılan tam GitLab CI ve GitHub Actions örnekleri için bkz. DevSecOps pipeline.

Hedef ekle (toplu, 1000'e kadar)

POST /api/v1/targets/bulk — alan adlarını veya IP'leri, isteğe bağlı olarak etiketlerle birlikte kabul eder. Planınızın hedef sınırına uyar.

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

Hedefleri sil (toplu)

DELETE /api/v1/targets/bulk — kimliklere göre veya değerlere göre (IP'ler / ana bilgisayar adları).

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

Etiketleri güncelle (toplu)

PATCH /api/v1/targets/tags — birçok hedefte etiketleri aynı anda ayarlayın, ekleyin veya kaldırın (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 spesifikasyonu

Tam makine tarafından okunabilir spesifikasyon /api/v1/openapi.json adresinde mevcuttur — bunu Postman, Insomnia veya kod üreticinize içe aktarın.