Controller: Ftp

API Controller /siteworx/ftp
Required Permissions ["FTP"]
Required Options FTP Accounts
Action Description
add Add an FTP account.
edit Edit a FTP account.
list List FTP accounts. DEPRECATED in version 4.8.0-393
listDeletable List deletable FTP accounts.
listFtpAccounts List FTP Accounts.

Action: add

Add an FTP account.

Input Parameters

Name Type Notes Required?
user string
Help Entry
Username of FTP user currently logged in
 Yes
password string Yes
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 Yes
homedir string
Example Default Value
/home/example
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: edit

Edit a FTP account.

Input Parameters

Name Type Notes Required?
user string
Example Values
ftp
 Yes
password string No
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 No
homedir string
Example Default Value
/home/example
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: list

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2010-11-18 use listFtpAccounts

List FTP accounts.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => 'ftp',
      1 => 'ftp@example.com',
    ),
  ),
)

Action: listDeletable

List deletable FTP accounts.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
  ),
)

Action: listFtpAccounts (Added in version 4.8.0-393)

List FTP Accounts.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'username' => 'ftp',
      'homedir' => '/home/example',
      'login_count' => '0',
      'ismaster' => true,
      'fulluser' => 'ftp@example.com',
    ),
  ),
)