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.

Authorizations:
query Parameters
required
string or string

The remote server's hostname or IP address.

Example: host=example.com
key_name
required
string

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.
Example: key_name=examplesshkey
key_passphrase
required
string >= 4 characters

The SSH key's password.

Example: key_passphrase=123456luggage
directory
string

The directory on the remote server that will store the backup.

Note:

This parameter defaults to the remote server account's default login directory.

Example: directory=/user
email
string <email>
Default: null

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.

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
port
integer [ 1 .. 65335 ]
Default: 22

The port to use during the transfer.

Example: port=22

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_scp_with_key host='example.com' key_name='examplesshkey' key_passphrase='123456luggage'

Response samples

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