---
title: "Health of specified checks"
method: GET
path: "/v1/health"
tags: ["health"]
---

# Health of specified checks

`GET /v1/health`

Fetch healthy status of specified checks.

See [Health endpoint](../health-checks#health-endpoint) for more details.

## Query parameters

- `level` 'alive' | 'ready'
- `names` string

## Response `200`

Check is healthy.

- GetHealthOKResponse
  - `type` string — Response type, "sync".
  - `status-code` integer — HTTP response status code.
  - `status` string — The description of the HTTP status code. See the [IANA list](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
  - `result` object
    - `healthy` true — True if the check is healthy, false otherwise.

## Other responses

- `502` — Check is not healthy.

## Changes

- **2025-01-13** `20135041d803` — 2 info
  - api tag `health` added
  - api tag `checks` removed
- **2025-01-02** `1cb37312be6c` — 2 info
  - added the non-success response with the status `502`
  - the `healthy` response property const value `true` was added for the status `200`
- **2024-12-24** `26cd4f832e9c` — 1 info
  - endpoint added
- **2024-12-22** `b3903318c3bd` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/canonical/apis/pebble-api/changes/v1/health/get.md)

---

[API](https://skmtc.dev/canonical/apis/pebble-api.md) · [All operations](https://skmtc.dev/canonical/apis/pebble-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/canonical/pebble-api/revisions/a94f353eccac/schema)