REST API Reference¶

Dashboard API¶

Base URL: http://localhost:9090/api/v1

GET /overview¶

System overview with summary metrics.

curl http://localhost:9090/api/v1/overview

Response:

{
  "system": {
    "version": "0.1.0",
    "uptime_seconds": 3600,
    "os": "linux",
    "arch": "x86_64"
  },
  "metrics": {
    "total_checks": 12345,
    "total_blocks": 234,
    "total_passed": 12111,
    "block_rate": 0.019,
    "avg_latency_ms": 2.5,
    "p50_latency_ms": 1.8,
    "p99_latency_ms": 15.3
  },
  "health": "healthy",
  "timestamp": "2026-01-25T12:00:00Z"
}

GET /metrics¶

Detailed metrics with per-guard breakdown.

GET /metrics/guards¶

Metrics grouped by guard name.

GET /alerts¶

Current alerts and thresholds.

POST /metrics/reset¶

Reset all metrics (admin operation).

Health Endpoints¶

Endpoint	Description
`/health`	Full health check
`/healthz`	Kubernetes liveness
`/ready`	Kubernetes readiness

Prometheus¶

GET /metrics

# HELP oxideshield_checks_total Total guard checks
# TYPE oxideshield_checks_total counter
oxideshield_checks_total 12345

# HELP oxideshield_blocks_total Total blocked requests
# TYPE oxideshield_blocks_total counter
oxideshield_blocks_total 234