Checks the health status of the CyborgDB microservice to verify connectivity and service availability.Documentation Index
Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
Use this file to discover all available pages before exploring further.
Returns
Dict[str, str]: Health status information from the service.
Exceptions
Error
Error
- Throws if the health check request fails due to network connectivity issues.
- Throws if the server is unreachable or times out.
Service Errors
Service Errors
- Throws if the CyborgDB service is unavailable or unreachable.
- Throws if there are internal server errors on the CyborgDB service.
Example Usage
Response Fields
| Field | Type | Description |
|---|---|---|
status | string | Current health status of the service (typically “healthy”) |
api_version | string | Version of the API interface (e.g., “v1”) |
version | string | Version of the CyborgDB application/service |