API Reference Overview
Base URL
https://breachspider.com/api/v1
Endpoint Categories
| Category | Base Path | Description |
|---|---|---|
| Health | /health | System status and pipeline health |
| CVEs | /cves | CVE search, detail, KEV, vendor, protocol |
| Dashboard | /dashboard | Personal posture dashboard |
| Environments | /environments | Site management and asset matching |
| Watchlist | /watchlist | Vendor and protocol watch subscriptions |
| Reports | /reports | PDF and compliance report generation |
| SAGE Chat | /chat | AI-powered vulnerability Q&A |
| Integrations | /integrations | API keys, connections, alert rules |
| Webhooks | /webhooks | Event delivery configuration |
| Training | /training | Platform training modules |
| Account | /account | User profile and billing |
| Catalog | /catalog | Vendor and protocol catalog |
Authentication
All endpoints except /health and /health/ping require authentication. See Authentication for details.
Response Format
All endpoints return the BreachSpider envelope. See Response Format for the full schema.
Versioning
The current API version is 1.0.0. The version is included in every response under api.version. Breaking changes will increment the major version and be announced at least 90 days in advance.