Health API

Health check endpoints for monitoring platform availability. These endpoints do not require authentication.

GET/api/v1/health

Basic Health Check

Returns basic service status, uptime, and environment.

JSON

{
  "success": true,
  "data": {
    "status": "ok",
    "timestamp": "2026-03-05T12:00:00Z",
    "uptime": 86400,
    "environment": "production"
  }
}

GET/api/v1/health/detailed

Detailed Health Check

Returns status of individual service dependencies. Returns 503 if any check fails.

JSON

1{
2  "success": true,
3  "data": {
4    "status": "healthy",
5    "timestamp": "2026-03-05T12:00:00Z",
6    "uptime": 86400,
7    "checks": {
8      "api": "up",
9      "database": "up",
10      "redis": "up"
11    },
12    "environment": "production"
13  }
14}

SDK Usage

TypeScript

const { data: status } = await client.health.check();
if (status.status !== 'healthy') {
  console.warn('Platform degraded:', status.checks);
}

const { data: pong } = await client.health.ping();
console.log(pong); // { pong: true, timestamp: '...' }