cPanel API 2 Functions - Ftp::listftp

Warning:

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

Description

This function lists an account's FTP users.

Warning:

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

Ftp::list_ftp — This function lists FTP account information.

Important:

When you disable the FTP 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=Ftp&cpanel_jsonapi_func=listftp

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.

// List the account's FTP users.
$list_ftpusers = $cpanel->api2(
    'Ftp', 'listftp'
);

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.

# List the account's FTP users.
my $list_ftpusers = $cpliveapi->api2(
    'Ftp', 'listftp',
);

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 Ftp listftp

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": "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"
  }
}

Note:

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

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