Child pages
  • cPanel API 1 Functions - Fileman::fullbackup
Skip to end of metadata
Go to start of metadata

Description

This function creates a full backup.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$create_backup = $cpanel->api1('Fileman', 'fullbackup', array('ftp', 'example.com', 'username', '12345luggage', 'user@example.com', '21', 'backup')); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $create_backup = $cpliveapi->api1('Fileman', 'fullbackup' ['ftp', 'example.com', 'username', '12345luggage', 'user@example.com', '21', 'backup']); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fullbakup ( $FORM('dest','server','user','pass','email','port','rdir'))">
 Command Line
cpapi1 --user=username Fileman fullbackup ftp example.com username 12345luggage user@example.com 21 backup


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
deststring

The backup's transfer protocol or destination.

This value defaults to homedir.

  • scp
  • ftp
  • passiveftp
  • homedir
ftp
serverstring

The backup's destination.

Important:

This parameter is required if you specify scp, ftp, or passiveftp for the dest parameter.

Any valid server.example.com
userstring

The remote server's username.

Important:

This parameter is required if you specify scp, ftp, or passiveftp for the dest parameter.

A valid username.select.html
passstring

The remote server's password.

Important:

This parameter is required if you specify scp, ftp, or passiveftp for the dest parameter.

The remote server's password.12345luggage
emailstring

Required

The email address to receive a confirmation email when the backup completes.

Any valid email address.user@example.com
portinteger

 The port to use during the transfer.

Important:

This parameter is required if you specify scp, ftp, or passiveftp for the dest parameter.

 Any valid port number. 21
rdir string

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

Important:

This parameter is required if you specify scp, ftp, or passiveftp for the dest parameter.

Any valid directory name.backup

Returns

This function does not return output.