---
title: "Return cparchive files list"
method: GET
path: "/list_cparchive_files"
tags: ["Backups", "Backup or Restore"]
---

# Return cparchive files list

`GET /list_cparchive_files`

This function lists all available cparchive files.

**Note:**

* `MM.DD.YYYY` represents the file's date in month, date, and year format.
* `HH-MM-SS` represents the file's timestamp in hour, minute, and second format.

The function checks the following filenames, where `USER` represents the cPanel account's filusername::
* `cpmove-USER`
* `cpmove-USER.tar`
* `cpmove-USER.tar.gz`
* `USER.tar`
* `USER.tar.gz`
* `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar`
* `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz`

The function checks for these filenames in the following locations:
* `/home`
* `/home2`
* `/home3`
* `/root`
* `/usr`
* `/usr/home`
* `/web`

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `quickrestore_files` object[] — An array of objects that contains information about each `cparchive` file.
      - `file` string — The backup file's name in one of the formats listed above.
      - `path` string — The backup file's directory in one of the locations listed above.
      - `user` string — The backup file's account.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)