# Health endpoints

> The unauthenticated status probe behind the status page. Every operation with parameters, body, responses, errors and examples.

Source: https://developers.processcart.com/reference/health

The unauthenticated status probe behind the status page.

Base URL `https://app.processcart.com/api/v1`. Every operation below is also in the [OpenAPI document](https://developers.processcart.com/openapi.json) and the [interactive reference](https://developers.processcart.com/reference).

| Operation | Method and path | Scope |
| --- | --- | --- |
| [Check that the API is up](#getHealth) | <code class="pc-docs-wrap">GET /v1<wbr>/health</code> | No credential |

## GET /v1/health
**Check that the API is up.** No credential. Operation id `getHealth` · [open in the API reference](https://developers.processcart.com/reference#tag/health/GET/v1/health).

The status-page probe: `{ "status": "ok" }` with 200 when the database answers, `{ "status": "degraded" }` with 503 otherwise. Unauthenticated, cached per instance for ten seconds, limited per client address, never logged.

**Responses**

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | OK. | [Health](https://developers.processcart.com/reference/schemas#health) |
| 405 | The verb is not supported on this path. `method_not_allowed` — Method not allowed. | [Problem](https://developers.processcart.com/errors) |
| 429 | `rate_limited` — Too many requests. | [Problem](https://developers.processcart.com/errors) |
| 500 | `internal_error` — Internal error. | [Problem](https://developers.processcart.com/errors) |
| 503 | The database did not answer in time: `{ "status": "degraded" }` (JSON, not a problem). | [Health](https://developers.processcart.com/reference/schemas#health) |

**Errors** (every code this operation can answer; see [Errors](https://developers.processcart.com/errors))

- 405 [`method_not_allowed`](https://developers.processcart.com/errors#method_not_allowed) — Method not allowed
- 429 [`rate_limited`](https://developers.processcart.com/errors#rate_limited) — Too many requests
- 500 [`internal_error`](https://developers.processcart.com/errors#internal_error) — Internal error
- 503 [`unavailable`](https://developers.processcart.com/errors#unavailable) — Service unavailable

**Example response** (200)

```json
{
  "status": "ok"
}
```