Skip to content

Getting started

This page takes a new organization from first sign-in to its first ranked fix list. It takes about 15 minutes with a spreadsheet of devices.

1. Sign in

BreachSpider has no passwords. Enter your work email at breachspider.com/login and open the sign-in link we email you. The link works once and expires after 60 minutes. You can add two-factor sign-in with an authenticator app later in Settings.

The web app is at breachspider.com/app.

Until you add devices, the Overview shows a sample plant: fictional devices with real products and versions, checked by the same engine. It is labelled Sample and is read only.

2. Add a site

A site is a place you keep devices, such as a plant or a building. Open Sites, choose Add a site and name it. Inside a site you can later set areas (lines, units) and zones (network zones) on each device.

3. Import your devices

Open Import (from Assets or the getting-started checklist) and upload a .csv or .xlsx file of up to 10,000 rows. One row per device:

Device name Vendor Model Version Zone Criticality
Line 2 PLC Siemens S7-1516-3 PN/DP V2.9 Cell 2 High
Core switch Moxa EDS-518A V3.5 Control High

Other header names work: you confirm how each column maps to a field. Then every row is checked against the product catalog and you review the ones that need a decision before anything is added. Details: Import.

Write versions the way the device shows them

The version is what makes results specific to your device. Without it, findings are listed for the whole product and none is confirmed. V3.5, 2.20, R510 and 10.0.17763.6189 are all fine.

Leave identifying details out

Do not put host names, IP addresses, MAC addresses, serial numbers or people's names in the device name or model. BreachSpider does not store IP addresses or serial numbers, and the API refuses fields that contain them. Use your own asset tags (for example PLC-LINE-2).

You can also add a single device from Assets with Add a device: type vendor, product and version, and it is checked at once.

4. Run the first check

Imported devices are checked automatically: a check of the site is queued and results appear in Assets when it finishes. Every device is also checked again every night, so new CVEs, new known-exploited listings and new vendor fixes reach your results without you doing anything. You can check everything again at any time with Check all assets now on Assets.

5. Read the results

  1. Overview: how many devices have confirmed findings, known-exploited CVEs, a fix available, ended support. Start with the Start here box: the first Fix first action.
  2. Fix first: the actions in the order to take them.
  3. Data quality: devices whose result is missing or not yet trustworthy, with what to do. Fixing these makes every other screen more complete.

6. Invite your team and set owners

In Settings, Team, invite colleagues as admins or viewers. In Assets, select devices and use the bulk actions to set owners, areas, zones, criticality and maintenance windows. These are your organization's notes: they never change a result or its order.

7. Record what you fix

When a device is updated, record the action from the device panel or Fix first (Record the fix) with the version now installed. BreachSpider checks the device again; findings clear only when that check confirms the new version is past the fixed one. Progress credits only these verified fixes.

Connect other tools

Sign in at breachspider.com/login. The web app is at breachspider.com/app. New here: Getting started.

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

Keys: Integrations in the web app, or a free 14 day trial key at breachspider.com/developers. Reference: Correlate CVEs.

pip install breachspider
import os, breachspider

bs = breachspider.Client(os.environ["BREACHSPIDER_API_KEY"])
resp = bs.correlate.correlate([{"asset_id": "SW-01", "vendor": "Moxa", "product": "EDS-518A", "version": "V3.5"}])
print(resp.results[0].fix_plan)

Guide: Python SDK.

pipx install breachspider-mcp
claude mcp add breachspider -e BREACHSPIDER_API_KEY="$BREACHSPIDER_API_KEY" -- breachspider-mcp

Runs on your own machine; only vendor, product, version and a neutral asset id leave it. Guide: MCP server (local).

Connect an assistant that supports remote MCP servers to:

https://mcp.breachspider.com/mcp

You sign in with your BreachSpider email and approve the access. Connecting by URL is turned on per organization: the Integrations page shows whether it is open for yours. Guide: Hosted MCP.