Skip to content

Watchlist

The watchlist lets you subscribe to specific vendors and protocols. CVE search results are ranked by watchlist relevance when ranked=true. New CVEs matching watchlisted entities trigger alert notifications.

Endpoints

Method Path Description
GET /api/v1/watchlist List watchlist entries
POST /api/v1/watchlist Add entry
DELETE /api/v1/watchlist/{entry_id} Remove entry

Add a Vendor

curl -X POST \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "vendor",
    "entity_id": 142
  }' \
  "https://breachspider.com/api/v1/watchlist"

Add a Protocol

curl -X POST \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "protocol",
    "entity_id": 7
  }' \
  "https://breachspider.com/api/v1/watchlist"

curl -H "Authorization: Bearer bs_live_..." \
  "https://breachspider.com/api/v1/cves?ranked=true&severity=CRITICAL"

Results with watchlisted vendors or protocols appear first.

Finding Vendor and Protocol IDs

Use the catalog endpoints to look up IDs:

# Find vendor ID
curl -H "Authorization: Bearer bs_live_..." \
  "https://breachspider.com/api/v1/catalog/vendors?q=siemens"

# Find protocol ID
curl -H "Authorization: Bearer bs_live_..." \
  "https://breachspider.com/api/v1/catalog/protocols?q=modbus"