> 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/references/interfaces/apis/data-product-apis/api-reference/health.md).

# Health

Technical contract for checking service availability and runtime health.

Health endpoints are intended for Kubernetes probes, load balancers, monitoring systems, and platform operators. They are mounted at the Data Product root, not under `/api/v1`, and do not require authentication.

## Liveness Probe

**API endpoint:** GET /livez

**Description:** Confirm that the API process is alive. A liveness monitor can restart the process if this probe stops responding successfully.

**cURL:**

{% code title="Liveness probe" %}

```bash
curl "$PRODUCT_BASE_URL/livez"
```

{% endcode %}

**Returns:** `200 OK`

```json
{
  "status": "alive"
}
```

***

## Readiness Probe

**API endpoint:** GET /readyz

**Description:** Confirm that the API is ready to receive traffic. Use readiness, not only liveness, before submitting queries.

**cURL:**

{% code title="Readiness probe" %}

```bash
curl "$PRODUCT_BASE_URL/readyz"
```

{% endcode %}

**Returns:** `200 OK`: ready:

```json
{
  "status": "ready"
}
```

`503 Service Unavailable`: not ready:

```json
{
  "status": "unhealthy",
  "reason": "worker_unavailable"
}
```

The service can be temporarily unready during startup, after repeated worker failures, or before the worker completes its startup grace period.

***

## Prometheus Metrics

**API endpoint:** GET /metrics

**Description:** Expose API runtime metrics for Prometheus scraping, including HTTP, cache, gateway, queue, and semantic-compilation measurements.

**cURL:**

{% code title="Prometheus metrics" %}

```bash
curl "$PRODUCT_BASE_URL/metrics"
```

{% endcode %}

**Returns:** `200 OK` with Prometheus text exposition format. A metrics-generation failure returns `500` with a text error comment.

```
# HELP vulcan_api_http_requests_total Total HTTP requests to the Vulcan API.
# TYPE vulcan_api_http_requests_total counter
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/health.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
