> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/foundations/activation/apis/api-reference/health.md).

# Health

Check whether the service is alive and ready before sending traffic. Mounted at the root — not under `/api/v1`.

{% hint style="info" %}
Use `/livez` and `/readyz` in CI/CD pipelines, uptime monitors, and readiness gates. Always check `/readyz` before bulk query runs — if the worker isn't ready, queries will fail with `503`.
{% endhint %}

{% tabs %}
{% tab title="GET /livez" %}

## GET /livez

**Summary:** Is the process running?

**Description:** Checks if the API process is alive. Use as a liveness probe to detect crashed or hung processes.

**cURL:**

{% code title="Liveness probe" %}

```bash
curl -s https://$BASE_URL/livez \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:** `{"status": "alive"}` — HTTP 200 when the process is running.
{% endtab %}

{% tab title="GET /readyz" %}

## GET /readyz

**Summary:** Is it ready to serve requests?

**Description:** Returns 200 only when the background worker is healthy. Returns 503 during startup or after failures.

**cURL:**

{% code title="Readiness probe" %}

```bash
curl -s https://$BASE_URL/readyz \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:**

* **200** — `{"status": "ready"}`
* **503** — `{"status": "unhealthy", "reason": "worker_unavailable"}`
  {% endtab %}
  {% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/concepts/foundations/activation/apis/api-reference/health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.