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

# Health check

`GET /health`

## Request

- Base URL: `https://api.workwing.io`
- URL: `https://api.workwing.io/health`
- Auth: none required

Returns a simple service status. Public callers receive `{ status }` only; detailed dependency checks require an internal health token.

## Response `200`

Every dependency check passed. Public callers receive `status` alone; a request carrying the internal health token also receives `version`, `checks`, `uptime` and `timestamp`.

- object: Every dependency check passed. Public callers receive `status` alone; a request carrying the internal health token also receives `version`, `checks`, `uptime` and `timestamp`.
  - `status` 'healthy', required
  - `version` string: Internal callers only
  - `checks` object: Internal callers only. The result of each dependency check.
    - `database` 'ok' | 'error', required
    - `redis` 'ok' | 'error', required
  - `uptime` number: Internal callers only. Process uptime in seconds.
  - `timestamp` string, date-time: Internal callers only

## Other responses

- `503`: At least one dependency check failed. The body has the same shape as the 200.

---

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