Health

Endpoints

GET /api/v1/health

Content-negotiated. Opening the endpoint in a browser (breachspider.com/api/v1/health) renders a live status page: an overall banner and per-service badges are public, while corpus counts, database size, disk usage, and pipeline timings are shown only to signed-in members. The page auto-refreshes every 30 seconds.

Requesting JSON (Accept: application/json, the default for API clients) returns the full machine-readable payload below and requires an authenticated session or the X-Internal-Key header. Used by internal monitoring; for unauthenticated uptime checks use /api/v1/health/ping.

# JSON (requires an authenticated session cookie)
curl -H "Accept: application/json" --cookie "bs_session=..." \
  https://breachspider.com/api/v1/health

Response

{
  "api": {
    "version": "1.0.0",
    "request_id": "bs-req-520be8d7ec44",
    "timestamp": "2026-06-07T13:26:29.000000Z",
    "processing_ms": 1
  },
  "data": {
    "status": "healthy",
    "database": "connected",
    "pipeline": {
      "ingest": {
        "status": "success",
        "last_run": "2026-06-07T04:00:38Z",
        "rows": 1842,
        "hours_since": 9.4,
        "duration_sec": 41.2
      },
      "enricher": {
        "status": "success",
        "last_run": "2026-06-07T05:12:00Z",
        "rows": 1840,
        "hours_since": 8.2,
        "duration_sec": 312.1
      }
    },
    "services": {
      "api": "operational",
      "enricher": "success",
      "renderer": "success",
      "alerts": "success"
    },
    "counts": {
      "total_cves": 360581,
      "alert_ready": 353588,
      "pending_enrichment": 0,
      "rendered": 312400
    },
    "db_size_mb": 4821.3,
    "disk_free_gb": 38.2
  },
  "meta": {
    "uptime_url": "https://status.breachspider.com",
    "version": "1.0.0",
    "environment": "production"
  }
}

Status Values

GET /api/v1/health/ping

Lightweight endpoint for basic liveness checks. Returns 200 with no database queries. Use this for load balancer health checks.

curl https://breachspider.com/api/v1/health/ping

{"ping": "pong"}