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.
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:
Example: directory=/public_ftp |
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.
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
Example: variant=active |
uapi --output=jsonpretty \ --user=username \ Backup \ fullbackup_to_ftp \ username='username' \ password='luggage123456' \ host='example.com'
{- "apiversion": 3,
- "func": "fullbackup_to_ftp",
- "module": "Backup",
- "result": {
- "data": {
- "pid": "2857"
}, - "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}