Skip to content

Reports

BreachSpider generates PDF reports for audit and executive communication. Reports are generated asynchronously and delivered via the portal or email.

Report Types

Type Description Tier
executive Executive summary with posture score and trend Standard+
compliance NERC CIP or IEC 62443 evidence package Professional+
environment Full findings for a single environment Standard+
cve Single CVE detail report (PDF) Free

Endpoints

Method Path Description
GET /api/v1/reports List generated reports
POST /api/v1/reports Generate new report
GET /api/v1/reports/{report_id} Get report status
GET /api/v1/reports/{report_id}/download Download PDF
DELETE /api/v1/reports/{report_id} Delete report

Generate an Executive Report

curl -X POST \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "report_type": "executive",
    "title": "Q2 2026 OT Security Posture",
    "environment_id": 5,
    "period_days": 90
  }' \
  "https://breachspider.com/api/v1/reports"

Generate a CVE PDF

Individual CVE reports are available immediately:

curl -H "Authorization: Bearer bs_live_..." \
  "https://breachspider.com/api/v1/ics-cve/CVE-2025-32433/pdf" \
  -o CVE-2025-32433.pdf

Report Status

{
  "id": 88,
  "report_type": "executive",
  "title": "Q2 2026 OT Security Posture",
  "status": "ready",
  "created_at": "2026-06-07T10:00:00Z",
  "completed_at": "2026-06-07T10:00:43Z",
  "download_url": "/api/v1/reports/88/download"
}

Status values: pending, generating, ready, failed

Model Selection

Executive and compliance reports use Claude Opus 4.8 for highest-quality prose. Standard reports use Claude Sonnet 4.6.