cPanel API 2 Functions - Fileman::uploadfiles

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the File Storage role, the system disables this function.

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

Note:

For more information, read our Calls from the WHM API documentation.

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'
    )
);

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.

# Upload files to the server.
my $uploadfiles = $cpliveapi->api2(
    'Fileman', 'uploadfiles',
    {
        'dir'       => 'public_html'
        'file-'     => 'file1-myfile.txt'
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

Command Line

cpapi2 --user=username Fileman uploadfiles dir=public_html file-=file1-myfile.txt

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

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

Note:

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

Parameters

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`dir`	string	Required The directory.	Any valid directory name.	`public_html`
`file-`	string	Required The files to upload. 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`

dir

string

Required

The directory.

Any valid directory name.

public_html

file-

string

Required

The files to upload.

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

Return	Type	Description	Possible values	Example
`reason`	string	A reason for failure. This function only returns a `reason` value 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`

reason

string

A reason for failure.

This function only returns a reason value 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