API 문서

인증

API 키를 베어러 토큰으로 또는 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 헤더가 포함됩니다. 제한을 초과하면 Retry-After 헤더와 함께 429를 반환합니다.

스캔 시작

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

스캔을 기다리고 심각한 발견 항목 발생 시 빌드를 실패시키는 전체 GitLab CI 및 GitHub Actions 예제는 DevSecOps 파이프라인을 참조하세요.

대상 추가 (대량, 최대 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 / 호스트명)으로 삭제합니다.

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 또는 코드 생성기로 가져오세요.