Return cparchive files list

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
SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/list_cparchive_files
Request samples
whmapi1 --output=jsonpretty \
  list_cparchive_files
Response samples
application/json
{
  • "data": {
    • "quickrestore_files": [
      • {
        • "file": "cpmove-username1.tar.gz",
        • "path": "/home",
        • "user": "username"
        }
      ]
    },
  • "metadata": {
    • "command": "list_cparchive_files",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}