API quick start¶
Check your first device in a few minutes.
1. Get a key¶
- Developers: start a free 14 day trial at breachspider.com/developers. No card. You get a read-only key for 750 device checks.
- Customers: make a key on Integrations in the web app.
export BREACHSPIDER_API_KEY=bs_live_...
2. Check a device¶
Send vendor, product and version exactly as your inventory has them. No CPE needed.
curl -X POST https://breachspider.com/api/v1/assets/correlate-cves \
-H "Authorization: Bearer $BREACHSPIDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"assets": [{"asset_id": "SW-01", "vendor": "Moxa", "product": "EDS-518A", "version": "V3.5"}]}'
For each device you get the product it resolved to and how sure that is, the CVEs that affect that version in priority order (each with its affected range, source and fix), the fix groups and fix plan, needs_review and two hashes. On 2026-11-08 this device returns three CVEs, all fixed by security patch 3.11.2 (Moxa MPSA-241156). Field by field: Correlate CVEs.
3. Check again cheaply¶
Keep each device's result_hash and status_hash. Later, ask only whether anything changed:
curl -X POST https://breachspider.com/api/v1/assets/correlate-cves/check \
-H "Authorization: Bearer $BREACHSPIDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"assets": [{"asset_id": "SW-01", "vendor": "Moxa", "product": "EDS-518A", "version": "V3.5", "result_hash": "sha256:..."}]}'
A change check costs a tenth of a device check.
4. Look up a CVE¶
curl -H "Authorization: Bearer $BREACHSPIDER_API_KEY" \
https://breachspider.com/api/v1/cves/CVE-2024-9137
5. Liveness¶
curl https://breachspider.com/api/v1/health/ping
Next¶
- Python:
pip install breachspider(Python SDK). - Assistants: MCP server (local) or Hosted MCP.
- Windows hosts: Windows patch level (API v2).
- When something fails: Errors and retry guidance.