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

# Readiness probe

`GET /health`

## Request

- Base URL: `https://optionsbell.com/api/v1`
- URL: `https://optionsbell.com/api/v1/health`
- Auth: none required

Public. Runs a trivial database query and reports its latency. Answers 503 `DB_UNHEALTHY` when the database is unreachable.

## Response `200`

Service and database healthy

- HealthResponse
  - `status` 'ok', required
  - `version` string, required
  - `timestamp` string, date-time, required
  - `db` object, required
    - `reachable` boolean, required
    - `latencyMs` integer, required

## Other responses

- `500`: Unexpected server error: `INTERNAL_ERROR`. The body and the X-Request-Id header carry the request id.
- `503`: Database unreachable (`DB_UNHEALTHY`).

---

[API](https://skmtc.dev/optionsbell/apis/optionsbell-options-flow-api.md) · [All operations](https://skmtc.dev/optionsbell/apis/optionsbell-options-flow-api/llms.txt) · [OpenAPI document](https://skmtc.dev/optionsbell/apis/optionsbell-options-flow-api/revisions/42db9bcaa61f?raw)