GET /health

Returns the health status of the AI Guard service. Used by load balancers, orchestrators, and monitoring systems to verify that the service is running.

Endpoint

GET /health

Authentication

None required. This endpoint does not require a bearer token.

Response

200 OK

The service is healthy and ready to accept requests. Returns an empty body.

curl Example

curl https://ai-guard.example.com:4443/health

With certificate pinning (for self-signed certificates):

curl https://ai-guard.example.com:4443/health \
  --pinnedpubkey "sha256//x48Lk2iu3R3nAhSiz07bExGHTusDRjHqBx9ArK3cFGE=" \
  --insecure

Use Cases

Kubernetes Liveness Probe

livenessProbe:
  httpGet:
    path: /health
    port: 4443
    scheme: HTTPS
  initialDelaySeconds: 5
  periodSeconds: 10

Kubernetes Readiness Probe

readinessProbe:
  httpGet:
    path: /health
    port: 4443
    scheme: HTTPS
  initialDelaySeconds: 5
  periodSeconds: 10

Load Balancer Health Check

Configure your load balancer to poll GET /health on port 4443. A 200 OK response indicates the service is ready to receive traffic.

Troubleshooting

Symptom	Possible Cause	Resolution
Connection refused	Service is not running	Check pod/container status
Connection timeout	Network/firewall issue	Verify port `4443` is accessible
TLS handshake failure	Certificate mismatch	Verify TLS configuration or use `--insecure` for testing

Updated 3 days ago