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.
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 parameter defaults to the remote server account's default login directory. Example: directory=/user |
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 .. 65335 ] Default: 22 The port to use during the transfer. Example: port=22 |
| apiversion | integer The version of the API. |
| func | string The name of the method called. |
| module | string The name of the module called. |
object |
uapi --user=username Backup fullbackup_to_scp_with_password host='example.com' username='username' password='luggage123456'
{- "apiversion": 3,
- "func": "fullbackup_to_scp_with_password",
- "module": "Backup",
- "result": {
- "data": {
- "pid": "2857"
}, - "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}