---
title: "Check API health"
description: "Returns whether the API and its required dependencies are healthy."
canonical: "https://www.cool.computer/docs/api-reference/public/check-api-health"
---
# Check API health

> Returns whether the API and its required dependencies are healthy.

```http
GET https://api.cool.computer/health
```

Returns whether the API and its required dependencies are healthy.

## Authorization

No credential is needed.

## Responses

- `200`: The API is healthy.
  - `application/json` (object)
    - `status` ("ok", required)
    - `release` (string, required): The build revision of the API process that answered.
    - `generation` (string): Present in production: the release generation the answering API process runs, which a deploy proves before it routes clients to that process.
    - `operator` ("ok" or "degraded"): Present when the server runs the operator agent: degraded while its workers or event listener are unavailable. The rest of the API stays healthy.
- `503`: Service Unavailable.
- `default`: A machine-readable API error with a stable code and recovery instruction.

An error is an `application/problem+json` document with a stable `code`; [API errors](/docs/api-reference/errors) says how to handle one.

## Example

```sh
curl "https://api.cool.computer/health"
```
