ShieldGate Docs

First proxy

Health and readiness

Use /health and /ready to know when the Proxy is safe to receive traffic.

Goal

Distinguish liveness from configuration readiness on the data plane.

Endpoints

Endpoint Meaning
GET /health Process is up
GET /ready Runtime config loaded (reports configVersion)

If no snapshot is loaded and DataPlane:AllowEmptyConfig is false, /ready returns 503.

Steps

  1. Call /health on Api and Proxy.
  2. Call /ready on Proxy after publish.
  3. Confirm the version matches Config → Active / Versions in the console.

Kubernetes / Compose tip

Point readiness probes at /ready, not only /health, so traffic waits for config.

Verify

A successful ready response after publish completes your first-proxy path.

Next

Deepen topology skills: Hosts