---
title: "Health Check"
description: "Simple liveness probe for the API. Free, no authentication required."
---

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

# Health Check

`GET /api/v1/health`

Simple liveness probe. Does not require authentication and never consumes credits.

:::tip
Use this before starting a batch job to verify the API is reachable. It's also useful as a health check endpoint for load balancers or uptime monitors.
:::

## Code examples

```bash title="cURL"
curl "https://kooperativa.io/api/v1/health"
```

```js title="JavaScript"
const res = await fetch("https://kooperativa.io/api/v1/health");
const { ok } = await res.json();
if (!ok) throw new Error("API is down");
```

## Response

```json
{ "ok": true }
```

:::note
HTTP `200` with `{ "ok": true }` means the API is up. Any other response or a connection error means the API is unavailable. Check [kooperativa.status.phare.io](https://kooperativa.status.phare.io) for status updates.
:::

Source: https://docs.kooperativa.io/account/health/index.mdx