Skip to main content
Checks the health status of the CyborgDB microservice to verify connectivity and service availability. 
client.get_health()

​
Returns

Dict[str, str]: Health status information from the service.

​
Exceptions

  • Throws if the health check request fails due to network connectivity issues.
  • Throws if the server is unreachable or times out.
  • Throws if the CyborgDB service is unavailable or unreachable.
  • Throws if there are internal server errors on the CyborgDB service.

​
Example Usage

health = client.get_health()
print(f"Service status: {health}")

​
Response Fields

FieldTypeDescription
statusstringCurrent health status of the service (typically “healthy”)
api_versionstringVersion of the API interface (e.g., “v1”)
versionstringVersion of the CyborgDB application/service