---
title: "Get the web app health check settings"
method: GET
path: "/WebApp/get_health_settings"
tags: ["WebApp", "Web Apps"]
---

# Get the web app health check settings

`GET /WebApp/get_health_settings`

## Request

- Base URL: `https://whm-server.tld:2087/json-api`
- URL: `https://whm-server.tld:2087/json-api/WebApp/get_health_settings`
- Auth: HTTP basic

This function returns the settings the scheduled web application
health check runs with.

These are the effective values, so a server whose settings have
never been changed reports the defaults rather than an empty
answer.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `auto_recovery` 0 | 1: Whether the scheduled health check may take action on an application at all. * `1` — It may restart or otherwise repair an application. * `0` — It takes no action on any application on the server. It still records what it finds, so the interface stays accurate.
    - `cooldown` integer: How long after the health check acts on an application before it may act on it again, in seconds.
    - `daily_cap` integer: The most times the health check may act on one application in a day. Past this, the fault is not transient and a person has to look at it.
    - `notify_admin` 0 | 1: Whether the server-wide alert emails anyone at all. * `1` — Email it when too many of the server's web applications are unhealthy at once. * `0` — Stay silent about it. This is the default; the pause on acting is not affected either way.
    - `notify_target` string: The account name or email address the server-wide alert goes to when `notify_admin` is on, or an empty string to send it to `root`, which is the default.
    - `sweep_interval` integer: The shortest gap between two health check passes, in seconds. The floor is 300, the gap the installed schedule delivers, so a shorter value is refused rather than silently ignored. Raising it is how a busy server checks less often.
  - `metadata` object
    - `command` string: The method name called.
    - `namespace` string: The namespace used in the API call.
    - `reason` string: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1: * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer: The version of the API function.

## Changes

- **2026-11-04** `6ca2c65397e3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/whm-api/changes/WebApp/get_health_settings/get.md)

---

[API](https://skmtc.dev/cpanel/apis/whm-api.md) - [All operations](https://skmtc.dev/cpanel/apis/whm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/whm-api/revisions/6ca2c65397e3?raw)