WebsiteBackup
Return website backups
Changed onThis function returns the website backups that cover the domain parameter, newest first.
Note:
- The function reads the JSON sidecar manifests under the account's website_backups directory and returns one row per manifest that covers the domain, either as the manifest's own domain or as a member of its site list.
- The function lists only backups that already exist. The WebsiteBackup::list_operations and WebsiteBackup::operation_status functions report an operation that is still in flight.
- The function skips a manifest that it cannot read rather than failing the call.
- 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_backups
Request
- Base URLhttps://cpanel-server.tld:2083/execute
- AuthHTTP basic
Query parameters
domainstring required
Example:example.com
The website whose backups to list.
Note: The account must own this domain.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_backups",
"module": "WebsiteBackup",
"result": {
"data": [
{
"createdMs": 1755520392000,
"databaseNames": [
"user_wordpress"
],
"id": "example.com-2026.08.18_12-53-12",
"includesDatabases": 1,
"name": "example.com-2026.08.18_12-53-12",
"relativePath": "website_backups/example.com-2026.08.18_12-53-12.tar.gz",
"sites": [
"example.com"
],
"sizeBytes": 104857600,
"source": "user",
"status": "ready",
"type": "website"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}Changes
- info
endpoint added
- info