We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


This function restores a backup to a directory.


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.


In cPanel & WHM version 88 and later, when you disable the File Storage role, the system disables this function.


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$restore_files = $cpanel->api1('Fileman', 'restorefiles', array('public_html','file-myfile.tar')); // Call the function.


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_file = $cpliveapi->api1('Fileman', 'restorefiles' ['user', 'file-myfile.tar]); # Call the function.


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

 cPanel Tag System (deprecated)


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::restorefiles ( $FORM('dir','file'))">
 Command Line
cpapi1 --user=username Fileman restorefiles public_html file-myfile.tar


  • 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:


 Output (plaintext)


ParameterTypeDescriptionPossible valuesExample

The directory into which to uncompress the backup file.

This parameter defaults to the user's /home directory.

Any valid directory name.public_html


The database.

Any valid database name.


This parameter's values must start with file-*.



This function returns a series file paths to the restored files.