Back up cPanel account via FTP

This function creates a full backup to the remote server via File Transfer Protocol (FTP). The system creates a file in the backup-MM.DD.YYYY_HH-mm-ss.tar.gz filename format.

Authorizations:
query Parameters
required
string or string

The remote server's hostname or IP address.

Example: host=example.com
password
required
string

The remote server account's password.

Example: password=luggage123456
username
required
string

The remote server account's username.

Example: username=username
directory
string

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

Note:

  • This value defaults to the remote server account's default login directory.
  • Enter the directory relative to the FTP user's login directory. For example, enter /public_ftp not /home/username/public_ftp.
Example: directory=/public_ftp
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 .. 65535 ]
Default: 21

The port number to use during the transfer.

Example: port=21
variant
string
Default: "active"

Whether to use the active or passive FTP variant to connect to the remote server. For more information about FTP variants, read our How to Enable FTP Passive Mode documentation.

  • active — The FTP server responds to the connection attempt and returns a connection request from a different port to the FTP client.
  • passive — The FTP client initiates connection attempts.
Enum: "active" "passive"
Example: variant=active

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_ftp username='username' password='luggage123456' host='example.com'

Response samples

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