query.system.check

Health check endpoint.

Method

query.system.check

Description

Returns the health status of the Cadenza API and its dependencies. Use for monitoring and verifying system availability.

Parameters

None required.

Result

Field	Type	Description
status	string	Health status ("healthy" or "unhealthy")
timestamp	integer	Health check timestamp (milliseconds)
version	string	API version
checks	object	Status of individual components (optional)

Checks Object

Field	Type	Description
database	object	Database connection status
temporal	object	Temporal workflow engine status
redis	object	Redis connection status

Usage

result = await client.rpc("query.system.check", {})

Example Response

{
  "status": "healthy",
  "timestamp": 1703052635110,
  "version": "3.0.1",
  "checks": {
    "database": { "status": "healthy" },
    "temporal": { "status": "healthy" },
    "redis": { "status": "healthy" }
  }
}