---
title: "Database Health"
method: GET
path: "/v1/database/health"
tags: ["Database & Monitoring"]
---

# Database Health

`GET /v1/database/health`

## Request

- Base URL: `https://api.bluehive.com`
- URL: `https://api.bluehive.com/v1/database/health`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/database/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Check MongoDB database connectivity and retrieve health statistics.

## Response `200`

Default Response

- object
  - `status` 'ok' | 'error', required: Database health status
  - `database` string: Database name (hidden in production)
  - `timestamp` string, required: Health check timestamp
  - `stats` object: Database statistics (not available in production)
    - `collections` number: Number of collections
    - `documents` number: Total number of documents
    - `dataSize` number: Total data size in bytes
  - `error` string: Error message if status is error

## Other responses

- `500`: Default Response

## Changes

- **2025-10-03** `2e0dd34abf24`: 1 info
  - the endpoint scheme security `ApiKeyAuth` was added to the API

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/database/health/get.md)

---

[API](https://skmtc.dev/bluehive-health/apis/bluehive-api.md) - [All operations](https://skmtc.dev/bluehive-health/apis/bluehive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluehive-health/apis/bluehive-api/revisions/a8bcbdf02e33?raw)