---
title: "Refresh a check"
method: POST
path: "/v1/checks/refresh"
tags: ["checks"]
---

# Refresh a check

`POST /v1/checks/refresh`

Runs a specified check immediately.

## Request body

- object
  - `name` string, required — The name of the check to refresh.

## Response `200`

Check refreshed successfully.

- RefreshCheckResponse
  - `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
    - `info` CheckInfo
      - `name` string — Name of the check.
      - `level` 'alive' | 'ready' — Level of the check.
      - `status` 'inactive' | 'down' | 'up' — Status of the check.
      - `successes` integer — Number of successes since check started or status transitioned from "down" to "up".
      - `failures` integer — Number of consecutive failures.
      - `threshold` integer — Failure threshold.
      - `change-id` string — ID of the change associated with the check.
      - `prev-change-id` string — ID of the previous change associated with the check.
    - `error` string — The error message if the check failed; empty string on success.

## Changes

- **2026-07-17** `a94f353eccac` — 1 info
  - added the optional property `allOf[subschema #2]/result/info/prev-change-id` to the response with the `200` status
- **2025-06-13** `21a795e24fb4` — 1 warning, 1 info
  - added the new `inactive` enum value to the `allOf[subschema #2]/result/info/status` response property for the response status `200`
  - added the optional property `allOf[subschema #2]/result/info/successes` to the response with the `200` status
- **2025-03-13** `1e0c43e45e13` — 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/checks/refresh/post.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)