ATTENTION

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

Customers

Customers.listing

lists all customer entries

Permission

admin

Parameter

FieldTypeDescription
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
show_usagesbooloptional, default false

Response

string as json-encoded array count|list

Customers.listingCount

returns the total number of customers for the given admin

Permission

admin

Response

string as json-encoded response message

Customers.add

create a new customer with default ftp-user and standard-subdomain (if wanted)

Permission

admin

Parameter

FieldTypeDescription
emailstring
namestringoptional if company is set, else required
firstnamestringoptional if company is set, else required
companystringoptional but required if name/firstname empty
streetstringoptional
zipcodestringoptional
citystringoptional
phonestringoptional
faxstringoptional
customernumberintoptional
def_languagestring,optional, default is system-default language
api_allowedbooloptional, default is true if system setting api.enabled is true, else false
genderintoptional, 0 = no-gender, 1 = male, 2 = female
custom_notesstringoptional notes
custom_notes_showbooloptional, whether to show the content of custom_notes to the customer, default 0(false)
new_loginnamestringoptional, if empty generated automatically using customer-prefix and increasingnumber
new_customer_passwordstringoptional, if empty generated automatically and send to the customer's email if$sendpassword is 1
sendpasswordbooloptional, whether to send the password to the customer after creation, default 0(false)
diskspaceintoptional disk-space available for customer in MB, default 0
diskspace_ulbooloptional, whether customer should have unlimited diskspace, default 0 (false)
trafficintoptional traffic available for customer in GB, default 0
traffic_ulbooloptional, whether customer should have unlimited traffic, default 0 (false)
subdomainsintoptional amount of subdomains available for customer, default 0
subdomains_ulbooloptional, whether customer should have unlimited subdomains, default 0 (false)
emailsintoptional amount of emails available for customer, default 0
emails_ulbooloptional, whether customer should have unlimited emails, default 0 (false)
email_accountsintoptional amount of email-accounts available for customer, default 0
email_accounts_ulbooloptional, whether customer should have unlimited email-accounts, default 0 (false)
email_forwardersintoptional amount of email-forwarders available for customer, default 0
email_forwarders_ulbooloptional, whether customer should have unlimited email-forwarders, default 0 (false)
email_quotaintoptional size of email-quota available for customer in MB, default is system-settingmail_quota
email_quota_ulbooloptional, whether customer should have unlimited email-quota, default 0 (false)
email_imapbooloptional, whether to allow IMAP access, default 0 (false)
email_pop3booloptional, whether to allow POP3 access, default 0 (false)
ftpsintoptional amount of ftp-accounts available for customer, default 0
ftps_ulbooloptional, whether customer should have unlimited ftp-accounts, default 0 (false)
mysqlsintoptional amount of mysql-databases available for customer, default 0
mysqls_ulbooloptional, whether customer should have unlimited mysql-databases, default 0 (false)
createstdsubdomainbooloptional, whether to create a standard-subdomain ([loginname].froxlor-hostname.tld),default [system.createstdsubdom_default]
phpenabledbooloptional, whether to allow usage of PHP, default 0 (false)
allowed_phpconfigsarrayoptional, array of IDs of php-config that the customer is allowed to use, defaultempty (none)
perlenabledbooloptional, whether to allow usage of Perl/CGI, default 0 (false)
dnsenabledbooloptional, whether to allow usage of the DNS editor (requires activated nameserver insettings), default 0 (false)
logviewenabledbooloptional, whether to allow access to webserver access/error-logs, default 0 (false)
store_defaultindexbooloptional, whether to store the default index file to customers homedir
hosting_plan_idintoptional, specify a hosting-plan to set certain resource-values from the planinstead of specifying them
allowed_mysqlserverarrayoptional, array of IDs of defined mysql-servers the customer is allowed to use,default is to allow the default dbserver (id=0)

Response

string as json-encoded array

Customers.get

return a customer entry by either id or loginname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the customer-id
loginnamestringoptional, the loginname
show_usagesbooloptional, default false

Response

string as json-encoded array

Customers.update

update customer entry by either id or loginname, customer can only change language, password and theme

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the customer-id
loginnamestringoptional, the loginname
emailstring
namestringoptional if company is set, else required
firstnamestringoptional if company is set, else required
companystringoptional but required if name/firstname empty
streetstringoptional
zipcodestringoptional
citystringoptional
phonestringoptional
faxstringoptional
customernumberintoptional
def_languagestring,optional, default is system-default language
api_allowedbooloptional, default is true if system setting api.enabled is true, else false
genderintoptional, 0 = no-gender, 1 = male, 2 = female
custom_notesstringoptional notes
custom_notes_showbooloptional, whether to show the content of custom_notes to the customer, default 0(false)
new_customer_passwordstringoptional, iset new password
sendpasswordbooloptional, whether to send the password to the customer after creation, default 0(false)
move_to_adminintoptional, if valid admin-id is given here, the customer's admin/reseller can bechanged
deactivatedbooloptional, if 1 (true) the customer can be deactivated/suspended
diskspaceintoptional disk-space available for customer in MB, default 0
diskspace_ulbooloptional, whether customer should have unlimited diskspace, default 0 (false)
trafficintoptional traffic available for customer in GB, default 0
traffic_ulbooloptional, whether customer should have unlimited traffic, default 0 (false)
subdomainsintoptional amount of subdomains available for customer, default 0
subdomains_ulbooloptional, whether customer should have unlimited subdomains, default 0 (false)
emailsintoptional amount of emails available for customer, default 0
emails_ulbooloptional, whether customer should have unlimited emails, default 0 (false)
email_accountsintoptional amount of email-accounts available for customer, default 0
email_accounts_ulbooloptional, whether customer should have unlimited email-accounts, default 0 (false)
email_forwardersintoptional amount of email-forwarders available for customer, default 0
email_forwarders_ulbooloptional, whether customer should have unlimited email-forwarders, default 0 (false)
email_quotaintoptional size of email-quota available for customer in MB, default is system-settingmail_quota
email_quota_ulbooloptional, whether customer should have unlimited email-quota, default 0 (false)
email_imapbooloptional, whether to allow IMAP access, default 0 (false)
email_pop3booloptional, whether to allow POP3 access, default 0 (false)
ftpsintoptional amount of ftp-accounts available for customer, default 0
ftps_ulbooloptional, whether customer should have unlimited ftp-accounts, default 0 (false)
mysqlsintoptional amount of mysql-databases available for customer, default 0
mysqls_ulbooloptional, whether customer should have unlimited mysql-databases, default 0 (false)
createstdsubdomainbooloptional, whether to create a standard-subdomain ([loginname].froxlor-hostname.tld),default 1 (if customer has std-subdomain) else 0 (false)
phpenabledbooloptional, whether to allow usage of PHP, default 0 (false)
allowed_phpconfigsarrayoptional, array of IDs of php-config that the customer is allowed to use, defaultempty (none)
perlenabledbooloptional, whether to allow usage of Perl/CGI, default 0 (false)
dnsenabledbooloptional, whether to allow usage of the DNS editor (requires activated nameserver insettings), default 0 (false)
logviewenabledbooloptional, whether to allow access to webserver access/error-logs, default 0 (false)
themestringoptional, change theme
allowed_mysqlserverarrayoptional, array of IDs of defined mysql-servers the customer is allowed to use,default is to allow the default dbserver (id=0)

Response

string as json-encoded array

Customers.delete

delete a customer entry by either id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the customer-id
loginnamestringoptional, the loginname
delete_userfilesbooloptional, default false

Response

string as json-encoded array

Customers.unlock

unlock a locked customer by either id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the customer-id
loginnamestringoptional, the loginname

Response

string as json-encoded array

Customers.move

Function to move a given customer to a given admin/reseller and update all its references accordingly

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the customer-id
loginnamestringoptional, the loginname
adminidinttarget-admin-id

Response

string as json-encoded array