Backup
Back up cPanel account via SCP with SSH key
This function creates a full backup to a remote server with a private SSH key via the secure copy protocol (scp) command. The system creates a file in the backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz filename format.
get/Backup/fullbackup_to_scp_with_key
Query parameters
The remote server's hostname or IP address.
key_namestring required
Example:examplesshkey
The SSH key's name.
Notes:
- To generate a private SSH key, use the UAPI SSL::generate_key function.
- To import an existing SSH key, use the cPanel API 2 SSH::importkey function.
key_passphrasestring required
Example:123456luggage
The SSH key's password.
directorystring
Example:/user
The directory on the remote server that will store the backup.
Note:
This parameter defaults to the remote server account's default login directory.
emailstring email
Example:username@example.com
The email address to receive a confirmation email when the backup 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.
portinteger
Example:22
The port to use during the transfer.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "fullbackup_to_scp_with_key",
"module": "Backup",
"result": {
"data": {
"pid": "2857"
},
"status": 1
}
}