Backup
Back up cPanel account to home directory
This function creates a full backup to the user's home directory. The system creates a file in the backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz filename format.
get/Backup/fullbackup_to_homedir
Query parameters
emailstring email
Example:username@example.com
The email address to receive a confirmation email when the backup process completes.
Note:
The system does not provide confirmation if you do not pass this parameter.
homedir'include' | 'skip'
Example:include
How to manage the home directory in the backup.
- include — Include the home directory in the backup.
- skip — Omit the home directory from the backup.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "fullbackup_to_homedir",
"module": "Backup",
"result": {
"data": {
"pid": "2857"
},
"status": 1
}
}