Dokumentasi API

Autentikasi

Kirim kunci API Anda sebagai bearer token atau dalam header X-API-Key:

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

Batas laju

120 permintaan per menit per kunci. Setiap respons menyertakan header X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset. Melampaui batas mengembalikan 429 dengan header Retry-After.

Mulai pemindaian

POST /api/v1/scans — mulai pemindaian sesuai permintaan pada sebuah target (ditambahkan ke akun Anda jika baru). Mengembalikan id pemindaian untuk dipantau.

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 & hasil pemindaian

GET /api/v1/scans/{id} — pantau hingga done bernilai true. Mengembalikan summary tingkat keparahan dan daftar findings — gunakan untuk meloloskan atau menggagalkan 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" } ] }

Lihat Pipeline DevSecOps untuk contoh lengkap GitLab CI dan GitHub Actions yang menunggu pemindaian dan menggagalkan build pada temuan kritis.

Tambah target (massal, hingga 1000)

POST /api/v1/targets/bulk — menerima domain atau IP, opsional dengan tag. Mematuhi batas target paket Anda.

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

Hapus target (massal)

DELETE /api/v1/targets/bulk — berdasarkan ID atau berdasarkan nilai (IP / hostname).

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

Perbarui tag (massal)

PATCH /api/v1/targets/tags — atur, tambah, atau hapus tag pada banyak target sekaligus (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"}'

Spesifikasi OpenAPI

Spesifikasi lengkap yang dapat dibaca mesin tersedia di /api/v1/openapi.json — impor ke Postman, Insomnia, atau generator kode Anda.