---
title: "Start cPanel & WHM update"
method: GET
path: "/start_cpanel_update"
tags: ["Server Administration", "Updates"]
---

# Start cPanel & WHM update

`GET /start_cpanel_update`

This function starts an update of cPanel & WHM.

## Query parameters

- `mode` 'force' | 'sync', nullable

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `is_new` 1 | 0 — Whether the update process started as a result of this request. * `1` — The update process started as a result of this request. * `0` — The update process existed prior to this request.
    - `log_path` string, path — The filesystem path to the update process’s log file.
    - `pid` integer — The update process’s ID.
  - `metadata` object
    - `command` string — The method name called.
    - `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` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)