---
title: "Return WordPress site restore status"
method: GET
path: "/WordPressRestore/any_running"
tags: ["WordPressRestore", "WordPress Manager Backups"]
---

# Return WordPress site restore status

`GET /WordPressRestore/any_running`

This function returns whether a WordPress® site backup restoration is in progress.

**Note:**

* You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.
* The output of this function changes, depending on the state of the backup restoration.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `items` union
        - RestoreInProgress
          - `any_running` 1 — Whether the system is processing a backup restoration. * `1` - Restoration in progress. This is the only possible value.
          - `sites` object[] — Information about the site that the system is actively restoring. **Note:** We have not implemented this return.
            - `id` 'null', nullable — The restore process's unique ID. * `null` is the only possible value. * We have not implemented this return.
            - `site` string, domain — The WordPress site's URL without the protocol prefix.
            - `type` 'restore' — The active process type. * `restore` is the only possible value.
        - RestoreNotInProgress
          - `any_running` 0 — Whether the system is processing a backup restoration. * `0` - No restoration in progress. This is the only possible value.
          - `last_outcome` object — The status of the last backup restoration.
            - `error` string, nullable — Where the system encountered an error during the last backup restoration. * The error message from the restoration log database. * `null` - No occur occurred.
            - `have_outcome` 0 | 1 — Whether the restoration log shows a successful attempt previously occurred, successfully or unsuccessfully. * `1` - Restoration attempt occurred. * `0` - No restoration attempt occurred.
            - `site` string, domain — The WordPress site's URL without the protocol prefix.
            - `status` 'success' | 'error' | 'terminated' | 'timeout' | 'low-disk' | 'low-quota' — The previous restoration attempt's result. * `success` - Successful restoration. * `error` - The attempted restoration resulted in an error. * `terminated` - The system stopped the restoration process. * `timeout` - The restoration process exceeded the allowed time limit. * `low-disk` - The server's disk space was insufficient to complete the restoration. * `low-quota` - The cPanel account's quota was insufficient to complete the restoration.
          - `sites` object — Information about the site that the system is actively restoring. **Note:** * This function returns an empty array when there is **not** an active backup restoration. This is the only possible value. * We have not implemented this return.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - 1 - Success. - 0 - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

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