cPanel API 1 Functions - Fileman::uploadfiles - Knowledgebase

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:

UAPI (recommended) — Fileman::upload_files — This function uploads files.
cPanel API 2 — Fileman::uploadfiles — This function uploads files.

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.

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.

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 dir=public_html file=file1-myfile.txt file=file2-myotherfile.txt

Notes:

You must URI-encode these values.
username represents your account-level username.

Output (plaintext)

test.html (test.html): upload succeeded, overwrote old file.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	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

Parameter

Type

Description

Possible values

Example

dir

string

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.

Knowledgebase

Categories

Categories