Get Health

Returns the health status of the CyborgDB service, to check that it is reachable and running.

client.get_health()

Returns

Dict[str, str] with these keys:

Key	Description
`status`	Service health, `"healthy"` when the service is up.
`api_version`	REST API version, e.g. `"v1"`.
`version`	CyborgDB service version.

Exceptions

cyborgdb.TransportError

The service can’t be reached.

cyborgdb.ServiceError

The service returns 5xx.

See Errors for the full hierarchy.

Example Usage

from cyborgdb import Client

client = Client(base_url='http://localhost:8000', api_key='your-api-key')

health = client.get_health()
print(health)
# Output: {'status': 'healthy', 'api_version': 'v1', 'version': '0.18.0'}

Introduction

Client

Encrypted Index

Types & Helpers

Returns

Exceptions

Example Usage

​Returns

​Exceptions

​Example Usage

Returns

Exceptions

Example Usage