> ## Documentation Index
> Fetch the complete documentation index at: https://clearlayer.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Health

> Check API availability.

## Check health

<code>GET /v1/health</code>

Returns the current status of the API and its database connection. Use this endpoint to verify the API is reachable before making authenticated requests. No API key is required.

***

## Response fields

<ResponseField name="status" type="string">
  `"healthy"` if the database is reachable, `"unhealthy"` if not.
</ResponseField>

<ResponseField name="timestamp" type="string">
  ISO 8601 timestamp of when the check was performed.
</ResponseField>

***

## Example

<CodeGroup>
  ```bash curl theme={null}
  curl https://clearlayer-api-production.up.railway.app/v1/health
  ```
</CodeGroup>

### 200 — Healthy

```json theme={null}
{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00.000Z"
}
```

### 503 — Unhealthy

Returned when the database is unreachable. If you receive this response, the API is up but dependent services are degraded.

```json theme={null}
{
  "status": "unhealthy",
  "timestamp": "2024-01-15T10:30:00.000Z"
}
```