---
title: "Return backup operation status"
method: GET
path: "/WebsiteBackup/operation_status"
tags: ["WebsiteBackup"]
---

# Return backup operation status

`GET /WebsiteBackup/operation_status`

## Request

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

This function reads the per-operation log for the `operationId`
parameter and returns its rolled-up status.

**Note:**

* This is the poll endpoint for the asynchronous
  `WebsiteBackup::create_backup`, `WebsiteBackup::restore_backup` and
  `WebsiteBackup::extract_backup` functions, each of which returns the
  id to poll.
* A client should keep polling until the `status` return value is no
  longer `inProgress`. If it loses the id, the
  `WebsiteBackup::list_operations` function returns the running
  operations for a domain.
* The function reads the log without opening it for append, so polling a
  live operation never disturbs it.
* A job killed mid-write leaves a truncated final frame, and the
  function still reports every complete frame, including the terminal
  one.
* An unknown or malformed `operationId` fails the call.
* This function requires the account's `backup` feature.

## Query parameters

- `operationId` 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 operation's rolled-up status.
      - `error` string: Localized, user-facing description of why the operation failed. **Note:** Present only when the `status` return value is `failed`.
      - `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.
      - `progressPct` number: Completion percentage, from 0 to 100. **Note:** Absent until the job reports progress, and exactly 100 once the operation is `ready`.
      - `startedAtMs` integer: Epoch milliseconds at which the operation started. **Note:** Absent when the log recorded no start time.
      - `status` 'inProgress' | 'ready' | 'failed': Rolled-up state of the operation. * `inProgress` - The background child has not yet written a terminal frame. * `ready` - The operation finished successfully. * `failed` - The operation ended in an error. See the `error` field.
      - `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.
      - `warnings` string[]: Localized descriptions of non-critical problems noted while the operation ran. **Note:** Absent when there were none.
    - `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 an API.

## Changes

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

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/WebsiteBackup/operation_status/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)