We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • cPanel API 2 Functions - Ftp::listftp
Skip to end of metadata
Go to start of metadata


This function lists an account's FTP users.


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


In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function.




 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'


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',


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


 cPanel Tag System (deprecated)


  • In cPanel & WHM version 11.30 and later, 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


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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:


 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"


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


This function does not accept parameters.


Return TypeDescriptionPossible valuesExample
userstringThe FTP username.A valid email address.example
typestringThe 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.
homedirstringThe path to the account's home directory.A valid absolute path./home/example

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.

Whether the function succeeded.

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