UAPI Functions - Ftp::list_ftp

Description

This function lists FTP account information.

Examples 


 cPanel or Webmail Session URL

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

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

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Ftp list_ftp

 

Notes:

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

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

 

Parameters

Parameter

Type

Description

Possible values

Example

skip_acct_types

 string 

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_types 

string

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

Return

Type

Description

Possible values

Example

type

string

The type of FTP account.

  • anonymous
  • logaccess
  • main
  • sub

main

 homedir 

 string 

 The absolute path to the FTP account's document root. 

The absolute path to the FTP account's document root.

 /home/user/public_html/ftp/ 

user

string

The FTP account username.

 The username for an FTP account on the cPanel account. 

ftpaccount

 

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