Skip to content

Health Check

Monitor the status of the CubeConnect platform.

GET /api/health

Request

No authentication required.

bash
curl https://cubeconnect.io/api/health

Response

Healthy 200 OK

json
{
  "success": true,
  "data": {
    "status": "healthy",
    "checks": {
      "app": true,
      "database": true,
      "cache": true
    },
    "timestamp": "2026-02-26T14:30:00Z"
  }
}

Degraded 503 Service Unavailable

json
{
  "success": false,
  "error": {
    "code": "SERVICE_DEGRADED",
    "message": "One or more platform checks failed.",
    "details": {
      "status": "degraded",
      "checks": {
        "app": true,
        "database": false,
        "cache": false
      },
      "timestamp": "2026-02-26T14:30:00Z"
    }
  }
}

Checks

CheckDescription
appApplication is running
databaseDatabase connection is active
cacheCache (Redis) is accessible

Usage

Use this endpoint to:

  • Monitoring - Set up uptime monitoring with tools like UptimeRobot, Pingdom, or custom scripts
  • Load Balancers - Configure health check probes
  • CI/CD - Verify deployment success
  • Alerting - Trigger alerts when status is degraded

CubeConnect WhatsApp Business Platform