Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.checkpoint.b-digital.uk/health \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {},
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

200 - application/json

API is healthy

success
boolean
Example:

true

data
object
meta
object