---
title: "Health check"
method: GET
path: "/health"
tags: ["Platform"]
---

# Health check

`GET /health`

## Request

- Base URL: `https://api.xpoz.ai`
- URL: `https://api.xpoz.ai/health`
- Auth: none required

Liveness and dependency health. Returns 503 when SingleStore is unhealthy.

## Response `200`

Healthy or degraded.

- HealthStatus
  - `status` 'healthy' | 'degraded' | 'unhealthy', required
  - `version` string, required
  - `uptime` number, required: Seconds.
  - `timestamp` string, date-time, required
  - `dependencies` object, required
    - `singlestore` ServiceHealth, required
      - `status` 'healthy' | 'degraded' | 'unhealthy', required
      - `responseTime` number
      - `error` string

## Other responses

- `503`: Unhealthy.

---

[API](https://skmtc.dev/xpoz/apis/xpoz-api.md) · [All operations](https://skmtc.dev/xpoz/apis/xpoz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xpoz/apis/xpoz-api/revisions/c18261f587a4?raw)