REST API: Health, Liveness & Readiness Probes Reference
RUSEON Core provides unauthenticated health endpoints designed for container orchestration probes (Kubernetes, Docker Swarm, Nomad) and load balancers.
1. Liveness Probe (GET /livez)
Determines whether the application process is running and able to handle HTTP events.
- URL:
http://localhost:8080/livez - Method:
GET - Authentication: None (Public)
Success Response (200 OK):
json
{
"status": "ok"
}2. Readiness Probe (GET /readyz)
Determines whether the server has initialized its storage engine and is ready to route traffic.
- URL:
http://localhost:8080/readyz - Method:
GET - Authentication: None (Public)
Success Response (200 OK):
json
{
"status": "ready"
}3. Kubernetes Deployment Manifest Example
yaml
livenessProbe:
httpGet:
path: /livez
port: 8080
initialDelaySeconds: 3
periodSeconds: 10
timeoutSeconds: 2
readinessProbe:
httpGet:
path: /readyz
port: 8080
initialDelaySeconds: 5
periodSeconds: 5
timeoutSeconds: 2