Description

This function lists FTP account information.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Ftp/list_ftp



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



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



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



uapi --user=username Ftp list_ftp



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



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
  • 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
  • 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