> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sdk.anghami.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Endpoints

> Liveness and readiness checks for monitoring SDK availability.

The API exposes a small set of health endpoints suitable for uptime monitors, status-page integrations, and agent freshness gates.

## Endpoints

| Endpoint                              | What it returns                                                                                                             |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `GET https://sdk.anghami.com/healthz` | Plain `200 OK` if the API process is alive. No body.                                                                        |
| `GET https://sdk.anghami.com/readyz`  | `200 OK` with a JSON body describing readiness, including dependency states. `503` if a critical dependency is unavailable. |

## Liveness vs readiness

* **Liveness (`/healthz`)** — "is the process up?" Use it for load-balancer probes and crash detection. Always cheap and unauthenticated.
* **Readiness (`/readyz`)** — "is the process ready to serve traffic?" Reflects upstream dependencies. Authenticated callers may see richer detail.

## Readiness body

```json theme={null}
{
  "status": "ok",
  "checked_at": "2026-04-30T12:34:56Z",
  "dependencies": {
    "catalog_db": "ok",
    "search_index": "ok",
    "stream_signing": "ok"
  }
}
```

`status` may be `ok`, `degraded`, or `unavailable`. `degraded` means some non-critical dependency is unhealthy — the API still serves most traffic but specific RPCs may return `ERROR_CODE_UNAVAILABLE`.

## Caching

* `/healthz` and `/readyz` are **never cached** (`Cache-Control: no-store`). Fresh on every fetch.
* Don't poll these aggressively from clients — they're for monitoring infrastructure, not in-app retry logic. For in-app retry, just retry your actual call with back-off.

## CORS

Both endpoints serve `Access-Control-Allow-Origin: *`. Safe to fetch from a status page or browser-based monitor.

## Status page

A public status page is hosted at [status.anghami.com](https://status.anghami.com) — incidents and maintenance windows surface there. Subscribe via RSS, email, or webhook for incident notifications.

<Note>
  **Coming soon.** The status page is being set up. Until it's live, watch the [SDK repo](https://github.com/anghami/sdk) for service announcements.
</Note>