WebsiteBackup
Return backup operation status
Changed onThis 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.
get/WebsiteBackup/operation_status
Request
- Base URLhttps://cpanel-server.tld:2083/execute
- AuthHTTP basic
Query parameters
operationIdstring required
Example:2026-08-18T12:53:12Z.1
Identifier of the operation to read.
Note: The WebsiteBackup::create_backup, WebsiteBackup::restore_backup, WebsiteBackup::extract_backup and WebsiteBackup::list_operations functions return this identifier.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "operation_status",
"module": "WebsiteBackup",
"result": {
"data": {
"error": "The system could not read the backup archive.",
"kind": "create",
"progressPct": 42,
"startedAtMs": 1755520392000,
"status": "inProgress",
"subStatus": "Archiving website files…",
"title": "Backing up “example.com”",
"warnings": [
"The system could not restore the database “user_store”."
]
},
"status": 1
}
}Changes
- info
endpoint added
- info