Get API health status

Returns the health status of the API and its dependencies

GET /health

JavaScript

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const health = await client.health.get();

console.log(health.data);

200

{
  "data": {
    "status": "healthy",
    "version": "1.0.0",
    "timestamp": "2026-05-15T19:48:45.167Z"
  }
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Health check response

data · object · required

Health check response payload

Show child attributes

Example:

{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2026-05-15T19:48:45.167Z"
}