Health check - Hrizn API Documentation

Health check

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/health

{
  "data": {
    "status": "ok",
    "version": "1.2.0",
    "timestamp": "2026-02-28T11:34:28.001Z"
  }
}

GET

health

Health check

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/health

{
  "data": {
    "status": "ok",
    "version": "1.2.0",
    "timestamp": "2026-02-28T11:34:28.001Z"
  }
}

Returns the API status. This endpoint does not require authentication.

This is the only endpoint that does not require an X-API-Key header. Use it to verify the API is operational before making authenticated requests.

{
  "data": {
    "status": "ok",
    "version": "1.2.0",
    "timestamp": "2026-02-28T11:34:28.001Z"
  }
}

200 - application/json

Service is healthy

data

object

Hide child attributes

data.status

string

Example:

"ok"

data.version

string

Example:

"1.2.0"

data.timestamp

string<date-time>

Last modified on March 1, 2026