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.

Authorizations:
query Parameters
email
string <email>
Default: null

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.

Example: email=username@example.com
homedir
string
Default: "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.
Enum: "include" "skip"
Example: homedir=include

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Backup fullbackup_to_homedir

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "fullbackup_to_homedir",
  • "module": "Backup",
  • "result": {
    • "data": {
      • "pid": "2857"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}