Get Health

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

async getHealth(): Promise<HealthResponse>

Returns

Promise<HealthResponse>, an object 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

CyborgDBServiceError

The service returns 5xx.

CyborgDBTransportError

The service can’t be reached.

See Errors for the full hierarchy.

Example Usage

import { Client } from 'cyborgdb';

const client = new Client({ baseUrl: 'http://localhost:8000', apiKey: 'your-api-key' });

const health = await client.getHealth();
console.log(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