Skip to main content
GET
/
api
/
v1
/
health
Database health check
curl --request GET \
  --url https://api.example.com/api/v1/health
{
  "status": 200,
  "message": "healthy",
  "data": {
    "cpu_usage_percent": 0.06,
    "mem_usage_percent": 1.31,
    "uptime": "72h3m0.5s"
  }
}

Documentation Index

Fetch the complete documentation index at: https://eigendb.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Response

Database is healthy.

​
status
integer
required

Status code of the response

​
message
string
required

Message giving basic information on the response

​
data
object

Important data to be given to the caller

​
error
object

An error that has occured