Child pages
  • UAPI Functions - Ftp::list_ftp
Skip to end of metadata
Go to start of metadata

Description

This function lists FTP account information.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/list_ftp


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List FTP account information.
$list_ftp_accts = $cpanel->uapi(
    'Ftp', 'list_ftp'
);


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 FTP account information.
my $list_ftp_accts = $cpliveapi->uapi(
    'Ftp', 'list_ftp',
);


Note:

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

 cPanel Template Toolkit
<!-- List FTP account information. -->
[% execute( 'Ftp', 'list_ftp' ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Ftp list_ftp


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "user": "example",
      "type": "main",
      "homedir": "/home/example"
    },
    {
      "user": "ftp",
      "type": "anonymous",
      "homedir": "/home/example/public_ftp"
    },
    {
      "user": "anonymous",
      "type": "anonymous",
      "homedir": "/home/example/public_ftp"
    },
    {
      "user": "example_logs",
      "type": "logaccess",
      "homedir": "/usr/local/apache/domlogs/example"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
skip_acct_typesstring

A list of the FTP account types to exclude from the function's results.

If you do not specify this parameter, this function does not exclude any account types.

  • anonymous
  • logaccess
  • main
  • sub

Notes:

  • Separate multiple types with the pipe character (|).
  • In browser-based calls, use %7C.
main|anonymous  
include_acct_typesstring

A list of the FTP account types to include in the function's results.

If you do not specify this parameter, this function returns all FTP account types.

  • anonymous
  • logaccess
  • main
  • sub

Notes:

  • Separate multiple types with the pipe character (|).
  • In browser-based calls, use %7C.
main|anonymous

Returns

ReturnTypeDescriptionPossible valuesExample
typestringThe type of FTP account.
  • anonymous
  • logaccess
  • main
  • sub
main
homedirstringThe absolute path to the FTP account's document root.The absolute path to the FTP account's document root./home/user/public_html/ftp/
userstringThe FTP account username.The username for an FTP account on the cPanel account.ftpaccount