cPanel API 2 Functions - Fileman::uploadfiles - Knowledgebase

Description

This function uploads files.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Fileman::upload_files — This function uploads files.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Fileman&cpanel_jsonapi_func=uploadfiles&dir=public_html&file-=file1-myfile.txt

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Upload files to the server.
$uploadfiles = $cpanel->api2(
    'Fileman', 'uploadfiles',
       array(
       'dir'        => 'public_html'
       'file-'      => 'file1-myfile.txt'
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Upload files to the server.
my $uploadfiles = $cpliveapi->api2(
    'Fileman', 'uploadfiles',
    {
        'dir'           => 'public_html'
        'file-'     => 'file1-myfile.txt'
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "uploadfiles",
    "data": [
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Return	Type	Description	Possible values	Example
dir	string	Required The directory.	Any valid directory name.	public_html
file-	string	Required The files to upload. Important: You must pass this parameter for each file to upload. You must increment each parameter name. For example, pass the first file as file1- and the second file as file2-.	Any valid, incremented filename.	file1-myfile.txt

Return

Type

Description

Possible values

Example

dir

string

Required

The directory.

Any valid directory name.

public_html

file-

string

Required

The files to upload.

Important:

You must pass this parameter for each file to upload.
You must increment each parameter name. For example, pass the first file as file1- and the second file as file2-.

Any valid, incremented filename.

file1-myfile.txt

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. This function only returns a reasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

This function only returns a reasonvalue if there was an error.

A string that describes the error.

This is an error message.

result

boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

Knowledgebase

Categories

Categories