Description
This function lists an account's FTP users.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Ftp&cpanel_jsonapi_func=listftp
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_ftpusers = $cpanel->api2(
'Ftp', 'listftp'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_ftpusers = $cpliveapi->api2(
'Ftp', 'listftp',
);
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.
Command Line
cpapi2 --user=username Ftp listftp
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "listftp",
"data": [
{
"user": "user",
"type": "sub",
"homedir": "/home/example/public_html/user"
},
{
"user": "example",
"type": "main",
"homedir": "/home/example"
},
{
"user": "example_logs",
"type": "logaccess",
"homedir": "/usr/local/apache/domlogs/example"
}
],
"event": {
"result": 1
},
"module": "Ftp"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
user
|
string
|
The FTP username.
|
A valid email address.
|
example
|
|
type
|
string
|
The type of FTP account.
|
- main — This is the main FTP account.
- sub — This is a sub-user FTP account.
- logaccess — This account is for logfile access.
|
main
|
|
homedir
|
string
|
The path to the account's home directory.
|
A valid absolute path.
|
/home/example
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns areason value if it failed.
|
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
|
