Health check

GET /api/health

Health check

cURL

curl --request GET \
  --url https://api.example.com/api/health \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "ok"
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Response

200 - application/json

Service is healthy.

status · enum<string> · required

Available options: ok