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

# Check service health

`GET /health`

## Request

- Base URL: `https://account.shieldlabs.ai`
- URL: `https://account.shieldlabs.ai/health`
- Auth: none required
- TypeScript: <https://skmtc.dev/shieldlabs/apis/shieldlabs-api/docs/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Liveness check. Returns `{"status":"ok"}` while the service answers. Available on both API
hosts: `https://account.shieldlabs.ai/health` for the History API and
`https://api.shieldlabs.ai/health`. No authentication, not rate
limited, not billed.

## Response `200`

The service is up.

- HealthStatus: Liveness status.
  - `status` 'ok', required: Always `ok` when the service answers.

## Other responses

- `404`: No route matches the path. The health check lives at the host root, so `/api/health` gets this answer. Plain text body.
- `502`: The edge proxy could not reach the service. HTML body. Retry with backoff.
- `504`: The service did not answer the edge proxy in time. HTML body. Retry with backoff.

---

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