Health Check

Healthcheck

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

{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

GET

health

Healthcheck

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

{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

Check the health status of the API service.

Authorization

string

header

required

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

200 - application/json

Successful Response

success

boolean

required

message

string | null

data

unknown

⌘I