Skip to main content
Quick navigation

API Healthcheck endpoints

Liveness endpoint​

/platform/api/modules/health/live

Return a status 200 when platform-api HTTP server is up.

cURL example
curl -s  http://localhost:8080/platform/api/modules/health/live
# "Ok"

Could be used to set up probes on Kubernetes or docker-compose.

docker-compose probe setup​

healthcheck:
  test:
    [
      'CMD-SHELL',
      'curl --fail http://localhost:${CDK_LISTENING_PORT:-8080}/platform/api/modules/health/live',
    ]
  interval: 10s
  start_period: 120s # Leave time for the psql init scripts to run
  timeout: 5s
  retries: 3

Kubernetes liveness probe​

Port configuration
ports:
  - containerPort: 8080
    protocol: TCP
    name: httpprobe
Probe configuration
livenessProbe:
  httpGet:
    path: /platform/api/modules/health/live
    port: httpprobe
  initialDelaySeconds: 5
  periodSeconds: 10
  timeoutSeconds: 5

Readiness/startup endpoint​

/platform/api/modules/health/ready

Return readiness of the platform and each module. Modules status :

  • STARTING (initial state)
  • UP
  • DOWN
  • DISABLED (disabled modules by license or manually)

This endpoint returns a 200 status code if all modules are in UP or DISABLED state.

Otherwise, it returns 503 ("Service Unavailable") if at least one module is in STARTING or DOWN state.

cURL example
curl -s  http://localhost:8080/platform/api/modules/health/ready | jq .
# {
#   "console": "UP",
#   "is_ready": true
# }

Kubernetes startup probe​

Port configuration

ports:
  - containerPort: 8080
    protocol: TCP
    name: httpprobe
Probe configuration
startupProbe:
    httpGet:
        path: /platform/api/modules/health/ready
        port: httpprobe
    initialDelaySeconds: 30
    periodSeconds: 10
    timeoutSeconds: 5
    failureThreshold: 30

Console Information​

Console versions​

/platform/api/modules/versions

This endpoint exposes module versions used to build the Console along with the overall Console version.

cURL example
curl -s  http://localhost:8080/platform/api/modules/versions | jq .
# {
#  "platform": "1.21.0",
#  "console": "059af990fff39541c76c0187edb5ea4e9f9ff69a",
#  "console_web": "4786261ab99e5048d997b4ff2538c4747f285a2b",
# }