---
title: "Return website backups"
method: GET
path: "/WebsiteBackup/list_backups"
tags: ["WebsiteBackup"]
---

# Return website backups

`GET /WebsiteBackup/list_backups`

## Request

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

This 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.

## 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 backups covering the requested domain, newest first. Empty when the account has none.
      - `createdMs` integer: Epoch milliseconds at which the backup was created. **Note:** The function returns rows newest first by this value.
      - `databaseNames` string[]: The databases dumped into this archive, so a restore can offer a per-database picker. **Note:** Empty for a files-only backup and for a legacy archive created before the system recorded names.
      - `id` string: Identifier of the backup, in the form `<domain>-<YYYY.MM.DD_HH-MM-SS>`. **Note:** Pass it to the `WebsiteBackup::restore_backup`, `WebsiteBackup::extract_backup` or `WebsiteBackup::delete_backup` function.
      - `includesDatabases` 1 | 0: Whether the archive holds any database dumps. * `1` - The archive includes databases. * `0` - The archive is website files only.
      - `name` string: Display name of the backup. **Note:** This falls back to the `id` return value when the manifest recorded no name.
      - `relativePath` string: Path of the archive relative to the account's home directory. Empty when the manifest recorded none.
      - `sites` string[]: The domains this archive covers.
      - `sizeBytes` integer: Size of the archive in bytes. `0` when the manifest recorded none.
      - `source` 'user' | 'system': Who created the backup. * `user` - The account created it. You can delete it through the `WebsiteBackup::delete_backup` function. * `system` - The server created it. It is not user-deletable.
      - `status` string: State of the archive itself. A listed backup is normally `ready`.
      - `type` 'website': Always `website`. **Note:** This distinguishes these rows from cPanel account backups.
    - `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_backups/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)