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

# Health Broker

`GET /health/broker`

## Request

- Base URL: `https://api.ctindex.io`
- URL: `https://api.ctindex.io/health/broker`
- Auth: none declared

Operator Redis broker memory probe. Requires a metrics scrape bearer token.

## Headers

- `authorization` string, nullable

## Response `200`

Successful Response

- BrokerHealthResponse: ``GET /health/broker`` — Redis broker memory high-water (Task 2).
  - `ok` boolean, required: True when the INFO memory probe succeeded AND used_memory is below ``BROKER_MEMORY_HIGH_WATER_PCT`` of maxmemory. False on probe failure (fail-closed) or when the high-water mark is hit.
  - `used_memory_bytes` integer, nullable: Redis ``used_memory`` from INFO memory.
  - `maxmemory_bytes` integer, nullable: Redis ``maxmemory`` from INFO memory.
  - `used_memory_pct` number, nullable: 100 * used_memory / maxmemory. Null when maxmemory is 0.
  - `maxmemory_policy` string, nullable: Redis ``maxmemory_policy`` (production is ``noeviction``).
  - `high_water_pct` number, required: Dispatch skip threshold (``BROKER_MEMORY_HIGH_WATER_PCT``, default 75).
  - `headroom_bytes` integer, nullable: maxmemory - used_memory, floored at 0.
  - `headroom_pct` number, nullable: 100 - used_memory_pct, floored at 0.
  - `over_high_water` boolean, required: True when used_memory_pct >= high_water_pct.
  - `probe_ok` boolean, required: True when INFO memory returned within BROKER_PROBE_TIMEOUT_MS.
  - `probe_error` string, nullable: timeout | connection_error | no_maxmemory when probe_ok is false.
  - `probe_timeout_ms` integer, required: Probe budget in milliseconds (``BROKER_PROBE_TIMEOUT_MS``, default 250).
  - `skip_dispatch` boolean, required: True when producers must leave shards pending. True on high-water OR any probe failure (fail-closed).
  - `skip_reason` string, nullable: broker_memory_high_water | broker_probe_timeout | broker_probe_failed | broker_maxmemory_unset.

## Other responses

- `422`: Validation Error

---

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