Skip to main content
GET
/
v1
/
health
Basic health check
curl --request GET \
  --url https://api.example.com/v1/health
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

Response

The Health Check is successful

​
status
string
Example:

"ok"

​
info
object
Example:
{ "database": { "status": "up" } }
​
error
object
Example:
{}
​
details
object
Example:
{ "database": { "status": "up" } }