Skip to content

BreachSpider documentation

BreachSpider tells you which known vulnerabilities (CVEs) affect the exact devices and versions you run, which fix clears the most of them, and whether each device is still supported by its vendor and on current firmware. Every answer links to the document that states it.

You give it what your inventory already says: a vendor, a product and a version, for example Moxa, EDS-518A, V3.5. You get back the CVEs that affect that version, the affected version range and where that range comes from, the fixed version, the vendor advisory and a plan for which update to install first. The same input always gives the same answer.

No CVEs is not the same as no risk

An empty result can mean the product was not identified, that no source publishes version data for it, or that the vendor no longer supports it and no longer publishes advisories. BreachSpider tells you which of these applies. Read Zero CVEs is not the same as no risk before you report a device as fine.

Where to start

You want to Start here
Understand what BreachSpider does and how it decides What BreachSpider does, then How matching works
Set up your organization and check your first devices Getting started
Learn a screen of the web app How the web app is organized
Call the API from your own system API overview and Correlate CVEs
Use Python Python SDK: pip install breachspider
Let an assistant such as Claude check devices MCP server (local) or Hosted MCP
Know how your data is protected and how backups are checked Security model and Integrity and backups
Read the full technical design Technical white paper

Install and connect

Sign in at breachspider.com/login. The web app is at breachspider.com/app.

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

A free 14 day trial key is at breachspider.com/developers.

pip install breachspider

Python 3.9 or newer. See Python SDK.

pipx install breachspider-mcp

Python 3.10 or newer. See MCP server (local).

https://mcp.breachspider.com/mcp

Sign in with your BreachSpider email when your assistant asks. See Hosted MCP.

Base URL and status

https://breachspider.com/api/v1

A no-sign-in liveness check: breachspider.com/api/v1/health/ping.

Help

Email [email protected] or use breachspider.com/contact.