Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Backup

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.

get/Backup/fullbackup_to_ftp

Query parameters

string hostname required

A valid hostname.

OR
string ipv4 required

A valid IP address.

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:/public_ftp

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.
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:21

The port number to use during the transfer.

variant'active' | 'passive'
Example: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.

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_ftp",
  "module": "Backup",
  "result": {
    "data": {
      "pid": "2857"
    },
    "status": 1
  }
}