เอกสาร API

การยืนยันตัวตน

ส่งคีย์ API ของคุณเป็น bearer token หรือในส่วนหัว X-API-Key:

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

ขีดจำกัดอัตรา

120 คำขอต่อนาทีต่อคีย์ ทุกการตอบสนองมีส่วนหัว X-RateLimit-Limit, X-RateLimit-Remaining และ X-RateLimit-Reset การเกินขีดจำกัดจะส่งคืน 429 พร้อมส่วนหัว Retry-After

เริ่มการสแกน

POST /api/v1/scans — เริ่มการสแกนตามต้องการบนเป้าหมาย (เพิ่มเข้าบัญชีของคุณหากเป็นเป้าหมายใหม่) ส่งคืน id ของการสแกนเพื่อตรวจสอบสถานะ

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

สถานะและผลการสแกน

GET /api/v1/scans/{id} — ตรวจสอบสถานะจนกว่า done จะเป็น true ส่งคืน summary ตามระดับความรุนแรงและรายการ findings — ใช้เพื่อให้ไปป์ไลน์ 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" } ] }

ดู ไปป์ไลน์ DevSecOps สำหรับตัวอย่าง GitLab CI และ GitHub Actions ฉบับเต็มที่รอการสแกนและทำให้ build ล้มเหลวเมื่อพบสิ่งที่ร้ายแรง

เพิ่มเป้าหมาย (แบบกลุ่ม สูงสุด 1000)

POST /api/v1/targets/bulk — รับโดเมนหรือ IP โดยเลือกใส่แท็กได้ เคารพขีดจำกัดเป้าหมายของแผนคุณ

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

ลบเป้าหมาย (แบบกลุ่ม)

DELETE /api/v1/targets/bulk — ตาม ID หรือตามค่า (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"]}'

อัปเดตแท็ก (แบบกลุ่ม)

PATCH /api/v1/targets/tags — ตั้งค่า เพิ่ม หรือลบแท็กบนหลายเป้าหมายพร้อมกัน (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

ข้อกำหนดฉบับสมบูรณ์ที่เครื่องอ่านได้มีอยู่ที่ /api/v1/openapi.json — นำเข้าไปยัง Postman, Insomnia หรือเครื่องมือสร้างโค้ดของคุณ