---
title: "Return running backup operations"
method: GET
path: "/WebsiteBackup/list_operations"
tags: ["WebsiteBackup"]
---

# Return running backup operations

`GET /WebsiteBackup/list_operations`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/WebsiteBackup/list_operations`
- Auth: HTTP basic

This function returns the backup, restore and extract operations still
running for the `domain` parameter, most recently updated first.

**Note:**

* A client that lost the operation identifier it was polling, after a
  page reload for example, can use this function to reattach its
  progress display. The work itself runs in a detached daemon and
  survives the reload. Only the caller's in-memory id is lost.
* Each row is the shape the `WebsiteBackup::operation_status` function
  returns, plus the `operationId` return value needed to resume polling.
* The function lists only operations that can still finish. It omits a
  terminal operation, meaning one that is `ready` or `failed`, because
  the `WebsiteBackup::list_backups` function reflects a completed
  backup. It also omits a non-terminal log whose daemon is no longer
  alive, which is a job that crashed without writing a terminal frame
  and can never complete.
* This function returns an array, so UAPI's generic `api.filter_*`,
  `api.sort_*` and `api.paginate_*` parameters apply, and a
  caller-supplied sort replaces the default ordering of the `data`
  return value.
* This function requires the account's `backup` feature.

## Query parameters

- `domain` string, required

## 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[]: The still-running operations for the requested domain. Empty when none are running. **Note:** The function orders rows by the operation log's last write, so most recently updated comes first. That is not necessarily most recently started. Sort on the `startedAtMs` return value if you need start order.
      - `domain` string: The website the operation is running against. Always the requested `domain` parameter.
      - `extractPath` string: For an `extract` operation, the home-relative destination folder the caller named in the `path` parameter of the `WebsiteBackup::extract_backup` function. **Note:** Absent for `create` and `restore`.
      - `kind` 'create' | 'restore' | 'extract': Which function started the operation. * `create` - The `WebsiteBackup::create_backup` function. * `restore` - The `WebsiteBackup::restore_backup` function. * `extract` - The `WebsiteBackup::extract_backup` function.
      - `operationId` string: Identifier to resume polling this operation through the `WebsiteBackup::operation_status` function.
      - `progressPct` number: Completion percentage, from 0 to 100. **Note:** Absent until the job reports its first progress frame. Never 100 here, because a finished operation is terminal and so is not listed.
      - `startedAtMs` integer: Epoch milliseconds at which the operation started. **Note:** Absent when the log recorded no start time.
      - `status` 'inProgress': Always `inProgress`, because this function does not list terminal operations.
      - `subStatus` string: Localized description of the step the operation is currently on. **Note:** Absent until the job logs its first step.
      - `title` string: Localized, user-facing title of the operation, for example `Backing up “example.com”`. **Note:** Empty string when the log recorded no title.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `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 an API.

## Changes

- **2026-09-12** `99adb57e7a5d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/WebsiteBackup/list_operations/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)