ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

Ftps

Ftps.add

add a new ftp-user

Permission

admin customer

Parameter

FieldTypeDescription
ftp_passwordstringpassword for the created database and database-user
pathstringdestination path relative to the customers-homedir
ftp_descriptionstringoptional, description for ftp-user
sendinfomailbooloptional, send created resource-information to customer, default: false
shellstringoptional, default /bin/false (not changeable when deactivated)
ftp_usernamestringoptional if customer.ftpatdomain is allowed, specify an username
ftp_domainstringoptional if customer.ftpatdomain is allowed, specify a domain (customer must be owner)
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
additional_membersarrayoptional whether to add additional usernames to the group
is_defaultuserbooloptional whether this is the standard default ftp user which is being added so no usage is decreased

Response

string as json-encoded array

Ftps.get

return a ftp-user entry by either id or username

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the customer-id
usernamestringoptional, the username

Response

string as json-encoded array

Ftps.update

update a given ftp-user by id or username

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the ftp-user-id
usernamestringoptional, the username
ftp_passwordstringoptional, update password if specified
pathstringdestination path relative to the customers-homedir
ftp_descriptionstringoptional, description for ftp-user
shellstringoptional, default /bin/false (not changeable when deactivated)
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)

Response

string as json-encoded array

Ftps.listing

list all ftp-users, if called from an admin, list all ftp-users of all customers you are allowed to view, or specify id or loginname for one specific customer

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select ftp-users of a specific customer by id
loginnamestringoptional, admin-only, select ftp-users of a specific customer by loginname
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

Ftps.listingCount

returns the total number of accessible ftp accounts

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select ftp-users of a specific customer by id
loginnamestringoptional, admin-only, select ftp-users of a specific customer by loginname

Response

string as json-encoded response message

Ftps.delete

delete a ftp-user by either id or username

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the ftp-user-id
usernamestringoptional, the username
delete_userfilesbooloptional, default false

Response

string as json-encoded array