---
title: "Force refresh a specific health check"
method: POST
path: "/api/v1/health/refresh/{checkName}"
tags: ["Health"]
---

# Force refresh a specific health check

`POST /api/v1/health/refresh/{checkName}`

## Request

- Base URL: `https://docs.anzworldline-solutions.com.au`
- URL: `https://docs.anzworldline-solutions.com.au/api/v1/health/refresh/{checkName}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/health/refresh/:checkName/post.ts> (a function with typed inputs; its response is checked against the schema)

Triggers an immediate refresh of a specific health check identified by name, bypassing any caching mechanisms. Useful for testing individual components or getting up-to-date status after targeted maintenance.

## Path parameters

- `checkName` string, required

## Response `200`

Successfully refreshed the health check

- ResponseEntityView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` object
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `403`: Forbidden - Authentication required
- `404`: Health check not found
- `500`: Internal Server Error

## Changes

- **2026-10-30** `4fd8e917d458`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/changes/api/v1/health/refresh/:checkName/post.md)

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) - [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/revisions/4fd8e917d458?raw)