You can find our user documentation at

Check out our new API beta site!

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


This function restores email filters or forwarder backups.


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


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


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


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

The contents of the uploaded file.


ParameterTypeDescriptionPossible valuesExample

The directory in which to store the uncompressed file backups.

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

Any valid directory name.public_html


The backup file to restore.

Any valid backup filename.


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


This function returns the uploaded file's contents.