API Documentation

Versioned endpoints for health checks, service status, and telemetry ingest.

Authentication

Use a token-based header with scoped access. Tokens are rotated regularly and are never embedded in URLs.

Header Authorization: Bearer <token>

GET /health

Lightweight readiness check for regional endpoints.

            {
              "status": "ok",
              "region": "us-east",
              "timestamp": "2026-01-30T09:15:00Z"
            }
          

GET /status

Service health summary with latency and availability snapshots.

            {
              "overall": "operational",
              "availability": 99.99,
              "latency_ms": 42,
              "tls_grade": "A+"
            }
          

POST /v1/metrics

Submit telemetry events for aggregation and alerting.

            {
              "service": "edge-gateway",
              "region": "eu-west",
              "uptime": 99.98,
              "latency_ms": 55,
              "tls_expiry_days": 46
            }
          

Response

Successful ingestion with tracking metadata.

            {
              "accepted": true,
              "ingest_id": "ing_64f1c3c9",
              "received_at": "2026-01-30T09:15:18Z"
            }
          