cPanel API 2 Functions - Ftp::listftp


This function lists an account's FTP users.


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

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



 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
// List the account's FTP users.
$list_ftpusers $cpanel->api2(

 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(

 cPanel Tag System (deprecated)


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



  • You must URI-encode values.
  • username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.



This function does not accept parameters.





Possible values




 The FTP username.

 A valid email address.




 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. 




 The path to the account's home directory.

 A valid absolute path.




 A reason for failure.


 This function only returns areason 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.



  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....