WebsiteBackup
Return running backup operations
Changed onThis 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.
get/WebsiteBackup/list_operations
Request
- Base URLhttps://cpanel-server.tld:2083/execute
- AuthHTTP basic
Query parameters
domainstring required
Example:example.com
The website whose running operations to list.
Note: The account must own this domain.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_operations",
"module": "WebsiteBackup",
"result": {
"data": [
{
"domain": "example.com",
"extractPath": "backup-restore/example.com",
"kind": "create",
"operationId": "2026-08-18T12:53:12Z.1",
"progressPct": 42,
"startedAtMs": 1755520392000,
"status": "inProgress",
"subStatus": "Archiving website files…",
"title": "Backing up “example.com”"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}Changes
- info
endpoint added
- info