You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Description

This function restores a database backup.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 88 and later, when the MySQL Client role is disabled, the system also disables this function.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$restore_database = $cpanel->api1('Fileman', 'restoredb', array('file-mydb1', 'public_html')); // 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 $restore_database = $cpliveapi->api1('Fileman', 'restoredb' ['file-myfile1', 'public_html']); # 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::restoredb ( $FORM('file','dir'))">
 Command Line
cpapi1 --user=username Fileman restoredb file-mydb


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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (SQL)

A series of SQL statements about the database's restoration.

Parameters

ParameterTypeDescriptionPossible valuesExample
filestring

Required

The database.


Any valid database name.

Important:

This parameter's values must start with the file- prefix.

file-mydb
dirstring

The directory into which to uncompress the backup file.

This value defaults to the cPanel account's /home directory.

Any valid directory name.public_html

Returns

This function returns a series of SQL statements about the database's restoration.