Health Check

GET 
/health

Health Check

Request

Responses

200

The Health Check is successful

application/json

Schema

Schema

status string
info objectnullable
property name* objectnullable
status stringrequired
property name* any
error objectnullable
property name* objectnullable
status stringrequired
property name* any
details object
property name* object
status stringrequired
property name* any

Example (from schema)

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

503

The Health Check is not successful

application/json

Schema

Schema

status string
info objectnullable
property name* objectnullable
status stringrequired
property name* any
error objectnullable
property name* objectnullable
status stringrequired
property name* any
details object
property name* object
status stringrequired
property name* any

Example (from schema)

{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  },
  "details": {
    "database": {
      "status": "up"
    },
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://docs.zrobank.io/health' \
-H 'Accept: application/json'

ResponseClear

Click the Send API Request button above and see the response here!