Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Backup

Back up cPanel account via SCP with password

This function creates a full backup to a remote server via the secure copy protocol (scp) command with a password. The system creates a file in the backup-MM.DD.YYYY_HH-mm-ss.tar.gz filename format.

get/Backup/fullbackup_to_scp_with_password

Query parameters

string ipv4 required

A valid ipv4 address.

OR
string hostname required

A valid hostname.

The remote server's hostname or IP address.

passwordstring required
Example:luggage123456

The remote server account's password.

usernamestring required
Example:username

The remote server account's username.

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.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "fullbackup_to_scp_with_password",
  "module": "Backup",
  "result": {
    "data": {
      "pid": "2857"
    },
    "status": 1
  }
}