GET
/
v1
/
database
/
health
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: process.env['BLUEHIVE_API_KEY'], // This is the default and can be omitted
});

const response = await client.database.checkHealth();

console.log(response.status);
{
  "status": "ok",
  "database": "<string>",
  "timestamp": "<string>",
  "stats": {
    "collections": 123,
    "documents": 123,
    "dataSize": 123
  },
  "error": "<string>"
}

Response

200
application/json

Default Response

The response is of type object.