Task
Version · 6.0
Create

Verify Liquibase Secure server health

Last updated: September 29, 2026

Use these checks after an installation or upgrade, and as the basis for ongoing monitoring. The install command runs its own health verification, so these steps confirm the deployment stays healthy afterward.

Procedure

Check service status

From the deployment directory, run:

./liquibase-platform status

The command displays each service with its status, health, and image, and runs a quick API health check:

Service       Status    Health     Image
------------------------------------------------------
api           running   healthy    registry.liquibase.com/liquibase-platform-api:0.1.0
web           running   healthy    registry.liquibase.com/liquibase-platform-web:0.1.0
db            running   healthy    timescale/timescaledb:2.17.2-pg14
secrets-db    running   healthy    postgres:14.17-alpine
redis         running   -          redis:7.4-alpine
nginx         running   -          nginx:1.27-alpine

Add --json for machine-readable output that includes all metrics.

Poll the health endpoints

The server API exposes three health endpoints. They are served through the deployment's HTTPS entry point under /api/.

Endpoint	Purpose	Use for
`GET /api/health`	Combined database health, primary and secrets	General monitoring
`GET /api/health/live`	Confirms the API process is running	Container restart decisions
`GET /api/health/ready`	Confirms all dependencies are connected	Load balancer routing

The health checks cover the primary database and the secrets database. Redis is used only for WebSocket pub/sub and is not included in the readiness check.

Be sure to:

Replace your_server_host with the hostname of your deployment. For example, liquibase.internal.example.com

curl https://your_server_host/api/health/ready

A healthy deployment returns HTTP 200:

{
  "status": "ok",
  "info": {
    "database": { "status": "up" },
    "secrets-database": { "status": "up" }
  },
  "error": {},
  "details": {
    "database": { "status": "up" },
    "secrets-database": { "status": "up" }
  }
}

An unhealthy deployment returns HTTP 503 and names the failing dependency:

{
  "status": "error",
  "info": { "secrets-database": { "status": "up" } },
  "error": { "database": { "status": "down", "message": "Connection refused" } }
}

Review logs

Stream logs from all services, or filter to one service:

./liquibase-platform logs -f
./liquibase-platform logs --service api --tail 50

In production mode the API writes structured JSON logs to stdout, so they can be forwarded to Splunk, ELK, or Datadog without transformation. Sensitive fields are redacted automatically, including the cookie and authorization request headers.

Generate a diagnostic bundle

When filing a support ticket, generate a diagnostic bundle:

./liquibase-platform logs --bundle

This creates a tarball named liquibase-platform-support-<timestamp>.tar.gz containing service logs, system information, container status, and a redacted copy of your environment configuration with secrets removed.

What to monitor

Health endpoint: Poll /api/health/ready every 30 seconds from your monitoring system.
Container restarts: Run docker compose ps and confirm the restart count is 0.
Disk space: Database volumes grow with operation volume over time.
Memory usage: Check docker stats for each service.
API response times: Check the application logs for the responseTime field.

PreviousConfigure Liquibase Secure server NextHosting options for an internal deployment