Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function uploads files to the server.

Warning:

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

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$upload_files = $cpanel->api1('Fileman', 'uploadfiles', array('public_html', 'file1-myfile.txt', 'file2-myotherfile.txt')); // 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 $upload_files = $cpliveapi->api1('Fileman', 'uploadfiles' ['public_html', 'file1-myfile.txt', 'file2-myotherfile.txt']); # 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. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::uploadfiles ( $FORM('dir','file1','file2'))">
 Command Line
cpapi1 --user=username Fileman uploadfiles public_html file1-myfile.txt file2-myotherfile.txt

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 (plaintext)
test.html (test.html): upload succeeded, overwrote old file.

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory to which to upload the files.

Any valid directory name.public_html
file*string

Required

The files to upload.

Important:

  • You must pass this parameter for each file that you upload.
  • You must increment each variable. For example, pass the first file as file1 and the second file as file2.
Any valid, incremented filename.file1-myfile.txt

Returns

This function returns a message of success or a reason for failure.