Skip to main content
Mole checking health

Health Endpoints

Health check and readiness endpoints.

GET /health​

Basic health check.

Response:

OK

Status: 200 OK

GET /healthz​

Detailed health with statistics.

Response:

{
  "status": "healthy",
  "running": true,
  "peer_count": 3,
  "stream_count": 42,
  "route_count": 5,
  "socks5_running": true,
  "exit_handler_running": false
}

Returns 503 Service Unavailable if agent is not running.

GET /ready​

Kubernetes readiness probe.

Response:

READY

Returns 200 if agent is ready to accept traffic. Returns 503 with "NOT READY" if agent is not running.

Examples​

# Basic health check
curl http://localhost:8080/health

# Detailed health
curl http://localhost:8080/healthz

# Readiness
curl http://localhost:8080/ready