Skip to main content
GET
/
health
Health check
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "status": "ok"
  }
}

Authorizations

X-API-Key
string
header
required

Response

200 - application/json

API is healthy (liveness)

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data