Liveness probe for container orchestration

GET

/api/system/status/alive

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Liveness probe endpoint for container orchestration health checks.

Simple endpoint that returns 200 OK if the service process is running. Used by Kubernetes, Docker, and other orchestration platforms to determine if the service should be restarted. This probe checks only if the process is alive, not if it’s ready to handle requests (use /ready endpoint for readiness checks).

Returns:

• LivenessResponse: Liveness status with fields:
  • status: Always ‘alive’ if endpoint is reachable
  • timestamp: Current server timestamp when probe executed

Raises:

• HTTPException(500): If timestamp cannot be generated

Cloud-Native Usage:

• Kubernetes: Configure as livenessProbe with GET /status/alive
• Docker Health: Use as HEALTHCHECK command
• Load Balancers: Basic uptime monitoring
• Auto-restart: Service restart decisions based on probe failures

Probe Configuration:

livenessProbe:
  httpGet:
    path: /status/alive
    port: 37737
  initialDelaySeconds: 10
  periodSeconds: 30
  timeoutSeconds: 5
  failureThreshold: 3

Note: Liveness probe should be simple and fast. Complex health checks belong in /ready endpoint.

Responses

200

Successful Response

LivenessResponse

Liveness probe response for container orchestration health checks.

Used by Kubernetes, Docker, and other orchestration platforms to determine if the service should be restarted. Simple alive/timestamp response.

Fields: status: Liveness status (always ‘alive’ if endpoint is reachable) timestamp: Current server timestamp when probe was executed

object

status

required

Status

string

timestamp

required

Timestamp

string format: date-time