Skip to main content
Mole checking health

Health Endpoints

Check if an agent is running and ready to handle traffic. Use these for load balancer health checks, container orchestration probes, or monitoring scripts.

Quick check:

curl http://localhost:8080/healthz
# Returns: peer count, stream count, route count, and status

GET /health​

Basic health check.

Response:

OK

Status: 200 OK

GET /healthz​

Detailed health check with statistics.

Response (200 OK):

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

Response (503 Service Unavailable):

{
  "status": "unavailable",
  "running": false
}

Returns 503 Service Unavailable if agent is not running.

GET /ready​

Readiness probe for container orchestration.

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

See Also​