Admins - create a new admin user
Command Admins.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
name
string
email
string
new_loginname
string
admin_password
stringdefault auto-generated
def_language
stringdefault is system-default language
api_allowed
booldefault is true if system setting api.enabled is true, else false
custom_notes
stringdefault empty
custom_notes_show
booldefault false
diskspace
intdefault 0
diskspace_ul
booldefault false
traffic
intdefault 0
traffic_ul
booldefault false
customers
intdefault 0
customers_ul
booldefault false
domains
intdefault 0
domains_ul
booldefault false
subdomains
intdefault 0
subdomains_ul
booldefault false
emails
intdefault 0
emails_ul
booldefault false
email_accounts
intdefault 0
email_accounts_ul
booldefault false
email_forwarders
intdefault 0
email_forwarders_ul
booldefault false
email_quota
intdefault 0
email_quota_ul
booldefault false
ftps
intdefault 0
ftps_ul
booldefault false
mysqls
intdefault 0
mysqls_ul
booldefault false
customers_see_all
booldefault false
domains_see_all
booldefault false
caneditphpsettings
booldefault false
change_serversettings
booldefault false
ipaddress
arraylist of ip-address id's; default -1 (all IP's)
Admins - delete a admin entry by either id or loginname
Command Admins.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe admin-id
loginname
stringthe loginname
Admins - return an admin entry by either id or loginname
Command Admins.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe admin-id
loginname
stringthe loginname
Admins - lists all admin entries
Command Admins.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Admins - returns the total number of admins for the given admin
Command Admins.listingCount


Access: admin
Returns string json-encoded array

Admins - unlock a locked admin by either id or loginname
Command Admins.unlock


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe admin-id
loginname
stringthe loginname
Admins - update an admin user by given id or loginname
Command Admins.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe admin-id
loginname
stringthe loginname
name
string
email
string
admin_password
stringdefault auto-generated
def_language
stringdefault is system-default language
api_allowed
booldefault is true if system setting api.enabled is true, else false
custom_notes
stringdefault empty
theme
string
deactivated
booldefault false
custom_notes_show
booldefault false
diskspace
intdefault 0
diskspace_ul
booldefault false
traffic
intdefault 0
traffic_ul
booldefault false
customers
intdefault 0
customers_ul
booldefault false
domains
intdefault 0
domains_ul
booldefault false
subdomains
intdefault 0
subdomains_ul
booldefault false
emails
intdefault 0
emails_ul
booldefault false
email_accounts
intdefault 0
email_accounts_ul
booldefault false
email_forwarders
intdefault 0
email_forwarders_ul
booldefault false
email_quota
intdefault 0
email_quota_ul
booldefault false
ftps
intdefault 0
ftps_ul
booldefault false
mysqls
intdefault 0
mysqls_ul
booldefault false
customers_see_all
booldefault false
domains_see_all
booldefault false
caneditphpsettings
booldefault false
change_serversettings
booldefault false
ipaddress
arraylist of ip-address id's; default -1 (all IP's)
Certificates - add new ssl-certificate entry for given domain by either id or domainname
Command Certificates.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
ssl_cert_file
string
ssl_key_file
string
ssl_ca_file
string
ssl_cert_chainfile
string
Certificates - delete certificates entry by id
Command Certificates.delete

Returns string json-encoded array

Parameter

FieldTypeDescription
id
int
Certificates - return ssl-certificate entry for given domain by either id or domainname
Command Certificates.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
Certificates - lists all certificate entries
Command Certificates.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Certificates - returns the total number of certificates for the given user
Command Certificates.listingCount


Access: admin, customer
Returns string json-encoded array

Certificates - update ssl-certificate entry for given domain by either id or domainname
Command Certificates.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
ssl_cert_file
string
ssl_key_file
string
ssl_ca_file
string
ssl_cert_chainfile
string
Cronjobs - You cannot add new cronjobs yet.
Command Cronjobs.add

Returns no-return-type

Cronjobs - You cannot delete system cronjobs.
Command Cronjobs.delete

Returns no-return-type

Cronjobs - return a cronjob entry by id
Command Cronjobs.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intcronjob-id
Cronjobs - lists all cronjob entries
Command Cronjobs.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Cronjobs - returns the total number of cronjobs
Command Cronjobs.listingCount


Access: admin
Returns string json-encoded array

Cronjobs - update a cronjob entry by given id
Command Cronjobs.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
int
isactive
boolwhether the cronjob is active or not
interval_value
intnumber of seconds/minutes/hours/etc. for the interval
interval_interval
stringinterval for the cronjob (MINUTE, HOUR, DAY, WEEK or MONTH)
CustomerBackups - add a new customer backup job
Command CustomerBackups.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
path
stringpath to store the backup to
backup_dbs
boolwhether to backup databases, default is 0 (false)
backup_mail
boolwhether to backup mail-data, default is 0 (false)
backup_web
boolwhether to backup web-data, default is 0 (false)
customerid
intrequired when called as admin, not needed when called as customer
CustomerBackups - delete a planned backup-jobs by id, if called from an admin you need to specify the customerid/loginname
Command CustomerBackups.delete


Access: admin, customer
Returns bool

Parameter

FieldTypeDescription
backup_job_entry
intid of backup job
customerid
intrequired when called as admin (if $loginname is not specified)
loginname
stringrequired when called as admin (if $customerid is not specified)
CustomerBackups - You cannot get a planned backup. Try CustomerBackups.listing()
Command CustomerBackups.get

Returns no-return-type

CustomerBackups - list all planned backup-jobs, if called from an admin, list all planned backup-jobs of all customers you are allowed to view, or specify id or loginname for one specific customer
Command CustomerBackups.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select backup-jobs of a specific customer by id
loginname
stringadmin-only, select backup-jobs of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
CustomerBackups - returns the total number of planned backups
Command CustomerBackups.listingCount


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, select backup-jobs of a specific customer by id
loginname
stringadmin-only, select backup-jobs of a specific customer by loginname
CustomerBackups - You cannot update a planned backup. You need to delete it and re-add it.
Command CustomerBackups.update

Returns no-return-type

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


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
email
string
name
stringif company is set, else required
firstname
stringif company is set, else required
company
stringbut required if name/firstname empty
street
string
zipcode
string
city
string
phone
string
fax
string
customernumber
int
def_language
stringdefault is system-default language
api_allowed
booldefault is true if system setting api.enabled is true, else false
gender
int0 = no-gender, 1 = male, 2 = female
custom_notes
stringnotes
custom_notes_show
boolwhether to show the content of custom_notes to the customer, default 0 (false)
new_loginname
stringif empty generated automatically using customer-prefix and increasing number
password
stringif empty generated automatically and send to the customer's email if $sendpassword is 1
sendpassword
boolwhether to send the password to the customer after creation, default 0 (false)
diskspace
intdisk-space available for customer in MB, default 0
diskspace_ul
boolwhether customer should have unlimited diskspace, default 0 (false)
traffic
inttraffic available for customer in GB, default 0
traffic_ul
boolwhether customer should have unlimited traffic, default 0 (false)
subdomains
intamount of subdomains available for customer, default 0
subdomains_ul
boolwhether customer should have unlimited subdomains, default 0 (false)
emails
intamount of emails available for customer, default 0
emails_ul
boolwhether customer should have unlimited emails, default 0 (false)
email_accounts
intamount of email-accounts available for customer, default 0
email_accounts_ul
boolwhether customer should have unlimited email-accounts, default 0 (false)
email_forwarders
intamount of email-forwarders available for customer, default 0
email_forwarders_ul
boolwhether customer should have unlimited email-forwarders, default 0 (false)
email_quota
intsize of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ul
boolwhether customer should have unlimited email-quota, default 0 (false)
email_imap
boolwhether to allow IMAP access, default 0 (false)
email_pop3
boolwhether to allow POP3 access, default 0 (false)
ftps
intamount of ftp-accounts available for customer, default 0
ftps_ul
boolwhether customer should have unlimited ftp-accounts, default 0 (false)
mysqls
intamount of mysql-databases available for customer, default 0
mysqls_ul
boolwhether customer should have unlimited mysql-databases, default 0 (false)
createstdsubdomain
boolwhether to create a standard-subdomain ([loginname].froxlor-hostname.tld), default 0 (false)
phpenabled
boolwhether to allow usage of PHP, default 0 (false)
allowed_phpconfigs
arrayarray of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabled
boolwhether to allow usage of Perl/CGI, default 0 (false)
dnsenabled
boolwether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false)
logviewenabled
boolwether to allow acccess to webserver access/error-logs, default 0 (false)
store_defaultindex
boolwhether to store the default index file to customers homedir
hosting_plan_id
intspecify a hosting-plan to set certain resource-values from the plan instead of specifying them
Customers - delete a customer entry by either id or loginname
Command Customers.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
loginname
stringthe loginname
delete_userfiles
booldefault false
Customers - return a customer entry by either id or loginname
Command Customers.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
loginname
stringthe loginname
Customers - lists all customer entries
Command Customers.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Customers - returns the total number of customers for the given admin
Command Customers.listingCount


Access: admin
Returns string json-encoded array

Customers - Function to move a given customer to a given admin/reseller and update all its references accordingly
Command Customers.move


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
loginname
stringthe loginname
adminid
inttarget-admin-id
Customers - unlock a locked customer by either id or loginname
Command Customers.unlock


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
loginname
stringthe loginname
Customers - update customer entry by either id or loginname, customer can only change language, password and theme
Command Customers.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
loginname
stringthe loginname
email
string
name
stringif company is set, else required
firstname
stringif company is set, else required
company
stringbut required if name/firstname empty
street
string
zipcode
string
city
string
phone
string
fax
string
customernumber
int
def_language
stringdefault is system-default language
api_allowed
booldefault is true if system setting api.enabled is true, else false
gender
int0 = no-gender, 1 = male, 2 = female
custom_notes
stringnotes
custom_notes_show
boolwhether to show the content of custom_notes to the customer, default 0 (false)
new_customer_password
stringiset new password
sendpassword
boolwhether to send the password to the customer after creation, default 0 (false)
move_to_admin
intif valid admin-id is given here, the customer's admin/reseller can be changed
deactivated
boolif 1 (true) the customer can be deactivated/suspended
diskspace
intdisk-space available for customer in MB, default 0
diskspace_ul
boolwhether customer should have unlimited diskspace, default 0 (false)
traffic
inttraffic available for customer in GB, default 0
traffic_ul
boolwhether customer should have unlimited traffic, default 0 (false)
subdomains
intamount of subdomains available for customer, default 0
subdomains_ul
boolwhether customer should have unlimited subdomains, default 0 (false)
emails
intamount of emails available for customer, default 0
emails_ul
boolwhether customer should have unlimited emails, default 0 (false)
email_accounts
intamount of email-accounts available for customer, default 0
email_accounts_ul
boolwhether customer should have unlimited email-accounts, default 0 (false)
email_forwarders
intamount of email-forwarders available for customer, default 0
email_forwarders_ul
boolwhether customer should have unlimited email-forwarders, default 0 (false)
email_quota
intsize of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ul
boolwhether customer should have unlimited email-quota, default 0 (false)
email_imap
boolwhether to allow IMAP access, default 0 (false)
email_pop3
boolwhether to allow POP3 access, default 0 (false)
ftps
intamount of ftp-accounts available for customer, default 0
ftps_ul
boolwhether customer should have unlimited ftp-accounts, default 0 (false)
mysqls
intamount of mysql-databases available for customer, default 0
mysqls_ul
boolwhether customer should have unlimited mysql-databases, default 0 (false)
createstdsubdomain
boolwhether to create a standard-subdomain ([loginname].froxlor-hostname.tld), default 0 (false)
phpenabled
boolwhether to allow usage of PHP, default 0 (false)
allowed_phpconfigs
arrayarray of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabled
boolwhether to allow usage of Perl/CGI, default 0 (false)
dnsenabled
boolether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false)
logviewenabled
boolether to allow acccess to webserver access/error-logs, default 0 (false)
theme
stringchange theme
DirOptions - add options for a given directory
Command DirOptions.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
path
stringpath relative to the customer's home-Directory
options_indexes
boolactivate directory-listing for this path, default 0 (false)
options_cgi
boolallow Perl/CGI execution, default 0 (false)
error404path
stringcustom 404 error string/file
error403path
stringcustom 403 error string/file
error500path
stringcustom 500 error string/file
DirOptions - delete a directory-options by id
Command DirOptions.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intid of dir-protection entry
DirOptions - return a directory-protection entry by id
Command DirOptions.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intid of dir-protection entry
DirOptions - list all directory-options, if called from an admin, list all directory-options of all customers you are allowed to view, or specify id or loginname for one specific customer
Command DirOptions.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select directory-protections of a specific customer by id
loginname
stringadmin-only, select directory-protections of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
DirOptions - returns the total number of accessable directory options
Command DirOptions.listingCount


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select directory-protections of a specific customer by id
loginname
stringadmin-only, select directory-protections of a specific customer by loginname
DirOptions - update options for a given directory by id
Command DirOptions.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intid of dir-protection entry
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
options_indexes
boolactivate directory-listing for this path, default 0 (false)
options_cgi
boolallow Perl/CGI execution, default 0 (false)
error404path
stringcustom 404 error string/file
error403path
stringcustom 403 error string/file
error500path
stringcustom 500 error string/file
DirProtections - add htaccess protection to a given directory
Command DirProtections.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
path
string
username
string
directory_password
string
directory_authname
stringname/description for the protection
DirProtections - delete a directory-protection by either id or username
Command DirProtections.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe directory-protection-id
username
stringthe username
DirProtections - return a directory-protection entry by either id or username
Command DirProtections.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe directory-protection-id
username
stringthe username
DirProtections - list all directory-protections, if called from an admin, list all directory-protections of all customers you are allowed to view, or specify id or loginname for one specific customer
Command DirProtections.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select directory-protections of a specific customer by id
loginname
stringadmin-only, select directory-protections of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
DirProtections - returns the total number of accessable directory protections
Command DirProtections.listingCount


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select directory-protections of a specific customer by id
loginname
stringadmin-only, select directory-protections of a specific customer by loginname
DirProtections - update htaccess protection of a given directory
Command DirProtections.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe directory-protection-id
username
stringthe username
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
directory_password
stringleave empty for no change
directory_authname
stringname/description for the protection
DomainZones - add a new dns zone for a given domain by id or domainname
Command DomainZones.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intdomain id
domainname
stringdomain name
record
stringdefault empty
type
stringzone-entry type (A, AAAA, TXT, etc.), default 'A'
prio
intpriority, default empty
content
stringdefault empty
ttl
intdefault 18000
DomainZones - deletes a domain-dns entry by id
Command DomainZones.delete


Access: admin, customer
Returns bool

Parameter

FieldTypeDescription
entry_id
int
id
intthe domain id
domainname
stringthe domain name
DomainZones - return a domain-dns entry by either id or domainname
Command DomainZones.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain id
domainname
stringthe domain name
DomainZones - List all entry records of a given domain by either id or domainname
Command DomainZones.listing


Access: admin, customer
Returns bool

Parameter

FieldTypeDescription
id
intthe domain id
domainname
stringthe domain name
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
DomainZones - returns the total number of domainzone-entries for given domain
Command DomainZones.listingCount


Access: admin, customer
Returns bool

Parameter

FieldTypeDescription
id
intthe domain id
domainname
stringthe domain name
DomainZones - You cannot update a dns zone entry. You need to delete it and re-add it.
Command DomainZones.update

Returns no-return-type

Domains - add new domain entry
Command Domains.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
domain
stringdomain-name
customerid
int
adminid
intdefault is the calling admin's ID
ipandport
arraylist of ip/ports to assign to domain, default is system-default-ips
subcanemaildomain
intallow subdomains of this domain as email domains, 1 = choosable (default no), 2 = choosable (default yes), 3 = always, default 0 (never)
isemaildomain
boolallow email usage with this domain, default 0 (false)
email_only
boolrestrict domain to email usage, default 0 (false)
selectserveralias
int0 = wildcard, 1 = www-alias, 2 = none, default 0
speciallogfile
boolwhether to create an exclusive web-logfile for this domain, default 0 (false)
alias
intdomain-id of a domain that the new domain should be an alias of, default 0 (none)
issubof
booldomain-id of a domain this domain is a subdomain of (required for webserver-cronjob to generate the correct order), default 0 (none)
registration_date
stringdate of domain registration in form of YYYY-MM-DD, default empty (none)
termination_date
stringdate of domain termination in form of YYYY-MM-DD, default empty (none)
caneditdomain
boolwhether to allow the customer to edit domain settings, default 0 (false)
isbinddomain
boolwhether to generate a dns-zone or not (only of nameserver is activated), default 0 (false)
zonefile
stringcustom dns zone filename (only of nameserver is activated), default empty (auto-generated)
dkim
boolcurrently not in use, default 0 (false)
specialsettings
stringcustom webserver vhost-content which is added to the generated vhost, default empty
ssl_specialsettings
stringcustom webserver vhost-content which is added to the generated ssl-vhost, default empty
include_specialsettings
boolwhether or not to include non-ssl specialsettings in the generated ssl-vhost, default false
notryfiles
bool[nginx only] do not generate the default try-files directive, default 0 (false)
writeaccesslog
boolEnable writing an access-log file for this domain, default 1 (true)
writeerrorlog
boolEnable writing an error-log file for this domain, default 1 (true)
documentroot
stringspecify homedir of domain by specifying a directory (relative to customer-docroot), be aware, if path starts with / it it considered a full path, not relative to customer-docroot. Also specifying a URL is possible here (redirect), default empty (autogenerated)
phpenabled
boolwhether php is enabled for this domain, default 0 (false)
openbasedir
boolwhether to activate openbasedir restriction for this domain, default 0 (false)
phpsettingid
intspecify php-configuration that is being used by id, default 1 (system-default)
mod_fcgid_starter
intnumber of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequests
intnumber of fcgid-maxrequests if FCGID is used, default is -1
ssl_redirect
boolwhether to generate a https-redirect or not, default false; requires SSL to be enabled
letsencrypt
boolwhether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled
ssl_ipandport
arraylist of ssl-enabled ip/port id's to assign to this domain, default empty
dont_use_default_ssl_ipandport_if_empty
booldo NOT set the systems default ssl ip addresses if none are given via $ssl_ipandport parameter
http2
boolwhether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false)
hsts_maxage
intmax-age value for HSTS header
hsts_sub
boolwhether or not to add subdomains to the HSTS header
hsts_preload
boolwhether or not to preload HSTS header value
ocsp_stapling
boolwhether to enable ocsp-stapling for this domain. default 0 (false), requires SSL
override_tls
boolwhether or not to override system-tls settings like protocol, ssl-ciphers and if applicable tls-1.3 ciphers, requires change_serversettings flag for the admin, default false
ssl_protocols
arraylist of allowed/used ssl/tls protocols, see system.ssl_protocols setting, only used/required if $override_tls is true, default empty or system.ssl_protocols setting if $override_tls is true
ssl_cipher_list
stringlist of allowed/used ssl/tls ciphers, see system.ssl_cipher_list setting, only used/required if $override_tls is true, default empty or system.ssl_cipher_list setting if $override_tls is true
tlsv13_cipher_list
stringlist of allowed/used tls-1.3 specific ciphers, see system.tlsv13_cipher_list setting, only used/required if $override_tls is true, default empty or system.tlsv13_cipher_list setting if $override_tls is true
Domains - delete a domain entry by either id or domainname
Command Domains.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
delete_mainsubdomains
boolremove also domains that are subdomains of this domain but added as main domains; default false
is_stdsubdomain
booldefault false, specify whether it's a std-subdomain you are deleting as it does not count as subdomain-resource
Domains - return a domain entry by either id or domainname
Command Domains.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
with_ips
booldefault true
no_std_subdomain
booldefault false
Domains - lists all domain entries
Command Domains.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
with_ips
booldefault true
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Domains - returns the total number of accessable domains
Command Domains.listingCount


Access: admin
Returns string json-encoded array count|list

Domains - update domain entry by either id or domainname
Command Domains.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
customerid
intcustomer-id
adminid
intdefault is the calling admin's ID
ipandport
arraylist of ip/ports to assign to domain, default is system-default-ips
subcanemaildomain
intallow subdomains of this domain as email domains, 1 = choosable (default no), 2 = choosable (default yes), 3 = always, default 0 (never)
isemaildomain
boolallow email usage with this domain, default 0 (false)
email_only
boolrestrict domain to email usage, default 0 (false)
selectserveralias
int0 = wildcard, 1 = www-alias, 2 = none, default 0
speciallogfile
boolwhether to create an exclusive web-logfile for this domain, default 0 (false)
speciallogverified
boolwhen setting $speciallogfile to false, this needs to be set to true to confirm the action, default 0 (false)
alias
intdomain-id of a domain that the new domain should be an alias of, default 0 (none)
issubof
booldomain-id of a domain this domain is a subdomain of (required for webserver-cronjob to generate the correct order), default 0 (none)
registration_date
stringdate of domain registration in form of YYYY-MM-DD, default empty (none)
termination_date
stringdate of domain termination in form of YYYY-MM-DD, default empty (none)
caneditdomain
boolwhether to allow the customer to edit domain settings, default 0 (false)
isbinddomain
boolwhether to generate a dns-zone or not (only of nameserver is activated), default 0 (false)
zonefile
stringcustom dns zone filename (only of nameserver is activated), default empty (auto-generated)
dkim
boolcurrently not in use, default 0 (false)
specialsettings
stringcustom webserver vhost-content which is added to the generated vhost, default empty
ssl_specialsettings
stringcustom webserver vhost-content which is added to the generated ssl-vhost, default empty
include_specialsettings
boolwhether or not to include non-ssl specialsettings in the generated ssl-vhost, default false
specialsettingsforsubdomains
boolwhether to apply specialsettings to all subdomains of this domain, default is read from setting system.apply_specialsettings_default
notryfiles
bool[nginx only] do not generate the default try-files directive, default 0 (false)
writeaccesslog
boolEnable writing an access-log file for this domain, default 1 (true)
writeerrorlog
boolEnable writing an error-log file for this domain, default 1 (true)
documentroot
stringspecify homedir of domain by specifying a directory (relative to customer-docroot), be aware, if path starts with / it it considered a full path, not relative to customer-docroot. Also specifying a URL is possible here (redirect), default empty (autogenerated)
phpenabled
boolwhether php is enabled for this domain, default 0 (false)
phpsettingsforsubdomains
boolwhether to apply php-setting to apply to all subdomains of this domain, default is read from setting system.apply_phpconfigs_default
openbasedir
boolwhether to activate openbasedir restriction for this domain, default 0 (false)
phpsettingid
intspecify php-configuration that is being used by id, default 1 (system-default)
mod_fcgid_starter
intnumber of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequests
intnumber of fcgid-maxrequests if FCGID is used, default is -1
ssl_redirect
boolwhether to generate a https-redirect or not, default false; requires SSL to be enabled
letsencrypt
boolwhether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled
ssl_ipandport
arraylist of ssl-enabled ip/port id's to assign to this domain, if left empty, the current set value is being used, to remove all ssl ips use $remove_ssl_ipandport
remove_ssl_ipandport
boolif set to true and no $ssl_ipandport value is given, the ip's get removed, otherwise, the currently set value is used, default false
http2
boolwhether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false)
hsts_maxage
intmax-age value for HSTS header
hsts_sub
boolwhether or not to add subdomains to the HSTS header
hsts_preload
boolwhether or not to preload HSTS header value
ocsp_stapling
boolwhether to enable ocsp-stapling for this domain. default 0 (false), requires SSL
EmailAccounts - add a new email account for a given email-address either by id or emailaddr
Command EmailAccounts.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intemail-address-id of email-address to add the account for
emailaddr
stringemail-address to add the account for
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
email_password
stringpassword for the account
alternative_email
stringemail address to send account information to, default is the account that is being created
email_quota
intquota if enabled in MB, default 0
sendinfomail
boolsends the welcome message to the new account (needed for creation, without the user won't be able to login before any mail is received), default 1 (true)
EmailAccounts - delete email-account entry for given email-address by either id or email-address
Command EmailAccounts.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to delete the account for
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
delete_userfiles
booldefault false
EmailAccounts - You cannot directly get an email account. You need to call Emails.get()
Command EmailAccounts.get

Returns no-return-type

EmailAccounts - You cannot directly list email accounts. You need to call Emails.listing()
Command EmailAccounts.listing

Returns no-return-type

EmailAccounts - You cannot directly count email accounts. You need to call Emails.listingCount()
Command EmailAccounts.listingCount

Returns no-return-type

EmailAccounts - update email-account entry for given email-address by either id or email-address
Command EmailAccounts.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to update
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
email_quota
intupdate quota
email_password
stringupdate password
EmailForwarders - add new email-forwarder entry for given email-address by either id or email-address
Command EmailForwarders.add


Access: admin,customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to add the forwarder for
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
destination
stringemail-address to add as forwarder
EmailForwarders - delete email-forwarder entry for given email-address by either id or email-address and forwarder-id
Command EmailForwarders.delete


Access: admin,customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to delete the forwarder from
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
forwarderid
intid of the forwarder to delete
EmailForwarders - You cannot directly get an email forwarder. Try EmailForwarders.listing()
Command EmailForwarders.get

Returns no-return-type

EmailForwarders - List email forwarders for a given email address
Command EmailForwarders.listing


Access: admin,customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to delete the forwarder from
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
EmailForwarders - count email forwarders for a given email address
Command EmailForwarders.listingCount


Access: admin,customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address to delete the forwarder from
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
EmailForwarders - You cannot update an email forwarder. You need to delete the entry and create a new one.
Command EmailForwarders.update

Returns no-return-type

Emails - add a new email address
Command Emails.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
email_part
stringname of the address before @
domain
stringdomain-name for the email-address
iscatchall
booleanmake this address a catchall address, default: no
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
Emails - delete an email address by either id or username
Command Emails.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
delete_userfiles
booleandelete email data from filesystem, default: 0 (false)
Emails - return a email-address entry by either id or email-address
Command Emails.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address
Emails - list all email addresses, if called from an admin, list all email addresses of all customers you are allowed to view, or specify id or loginname for one specific customer
Command Emails.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select email addresses of a specific customer by id
loginname
stringadmin-only, select email addresses of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Emails - returns the total number of accessable email addresses
Command Emails.listingCount


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, select email addresses of a specific customer by id
loginname
stringadmin-only, select email addresses of a specific customer by loginname
Emails - toggle catchall flag of given email address either by id or email-address
Command Emails.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe email-address-id
emailaddr
stringthe email-address
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
iscatchall
boolean
FpmDaemons - create a new fpm-daemon entry
Command FpmDaemons.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
description
string
reload_cmd
string
config_dir
string
pm
stringprocess-manager, one of 'static', 'dynamic' or 'ondemand', default 'static'
max_children
intdefault 0
start_servers
intdefault 0
min_spare_servers
intdefault 0
max_spare_servers
intdefault 0
max_requests
intdefault 0
idle_timeout
intdefault 0
limit_extensions
stringlimit execution to the following extensions, default '.php'
FpmDaemons - delete a fpm-daemon entry by id
Command FpmDaemons.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intfpm-daemon-id
FpmDaemons - return a fpm-daemon entry by id
Command FpmDaemons.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intfpm-daemon-id
FpmDaemons - lists all fpm-daemon entries
Command FpmDaemons.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
FpmDaemons - returns the total number of accessable fpm daemons
Command FpmDaemons.listingCount


Access: admin
Returns string json-encoded array

FpmDaemons - update a fpm-daemon entry by given id
Command FpmDaemons.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intfpm-daemon id
description
string
reload_cmd
string
config_dir
string
pm
stringprocess-manager, one of 'static', 'dynamic' or 'ondemand', default 'static'
max_children
intdefault 0
start_servers
intdefault 0
min_spare_servers
intdefault 0
max_spare_servers
intdefault 0
max_requests
intdefault 0
idle_timeout
intdefault 0
limit_extensions
stringlimit execution to the following extensions, default '.php'
Froxlor - checks whether there is a newer version of froxlor available
Command Froxlor.checkUpdate


Access: admin
Returns string json-encoded array

Froxlor - export settings
Command Froxlor.exportSettings


Access: admin
Returns string json-string

Froxlor - return a setting by settinggroup.varname couple
Command Froxlor.getSetting


Access: admin
Returns string

Parameter

FieldTypeDescription
key
stringsettinggroup.varname couple
Froxlor - import settings
Command Froxlor.importSettings


Access: admin
Returns string json-encoded bool

Parameter

FieldTypeDescription
json_str
stringcontent of exported froxlor-settings json file
Froxlor - returns a list of all available api functions
Command Froxlor.listFunctions


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
module
stringreturn list of functions for a specific module
Froxlor - return a list of all settings
Command Froxlor.listSettings


Access: admin
Returns string json-encoded array count|list

Froxlor - updates a setting
Command Froxlor.updateSetting


Access: admin
Returns string

Parameter

FieldTypeDescription
key
stringsettinggroup.varname couple
value
stringthe new value, default is ''
Ftps - add a new ftp-user
Command Ftps.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
ftp_password
stringpassword for the created database and database-user
path
stringdestination path relative to the customers-homedir
ftp_description
stringdescription for ftp-user
sendinfomail
boolsend created resource-information to customer, default: false
shell
stringdefault /bin/false (not changeable when deactivated)
ftp_username
stringif customer.ftpatdomain is allowed, specify an username
ftp_domain
stringif customer.ftpatdomain is allowed, specify a domain (customer must be owner)
customerid
intrequired when called as admin, not needed when called as customer
additional_members
arraywhether to add additional usernames to the group
is_defaultuser
boolwhether this is the standard default ftp user which is being added so no usage is decreased
Ftps - delete a ftp-user by either id or username
Command Ftps.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe ftp-user-id
username
stringthe username
delete_userfiles
booldefault false
Ftps - return a ftp-user entry by either id or username
Command Ftps.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
username
stringthe username
Ftps - 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
Command Ftps.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select ftp-users of a specific customer by id
loginname
stringadmin-only, select ftp-users of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Ftps - returns the total number of accessable ftp accounts
Command Ftps.listingCount


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, select ftp-users of a specific customer by id
loginname
stringadmin-only, select ftp-users of a specific customer by loginname
Ftps - update a given ftp-user by id or username
Command Ftps.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe customer-id
username
stringthe username
ftp_password
stringpassword for the created database and database-user
path
stringdestination path relative to the customers-homedir
ftp_description
stringdescription for ftp-user
shell
stringdefault /bin/false (not changeable when deactivated)
customerid
intrequired when called as admin, not needed when called as customer
HostingPlans - add new hosting-plan
Command HostingPlans.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
name
stringname of the plan
description
stringdescription for hosting-plan
diskspace
intdisk-space available for customer in MB, default 0
diskspace_ul
boolwhether customer should have unlimited diskspace, default 0 (false)
traffic
inttraffic available for customer in GB, default 0
traffic_ul
boolwhether customer should have unlimited traffic, default 0 (false)
subdomains
intamount of subdomains available for customer, default 0
subdomains_ul
boolwhether customer should have unlimited subdomains, default 0 (false)
emails
intamount of emails available for customer, default 0
emails_ul
boolwhether customer should have unlimited emails, default 0 (false)
email_accounts
intamount of email-accounts available for customer, default 0
email_accounts_ul
boolwhether customer should have unlimited email-accounts, default 0 (false)
email_forwarders
intamount of email-forwarders available for customer, default 0
email_forwarders_ul
boolwhether customer should have unlimited email-forwarders, default 0 (false)
email_quota
intsize of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ul
boolwhether customer should have unlimited email-quota, default 0 (false)
email_imap
boolwhether to allow IMAP access, default 0 (false)
email_pop3
boolwhether to allow POP3 access, default 0 (false)
ftps
intamount of ftp-accounts available for customer, default 0
ftps_ul
boolwhether customer should have unlimited ftp-accounts, default 0 (false)
mysqls
intamount of mysql-databases available for customer, default 0
mysqls_ul
boolwhether customer should have unlimited mysql-databases, default 0 (false)
phpenabled
boolwhether to allow usage of PHP, default 0 (false)
allowed_phpconfigs
arrayarray of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabled
boolwhether to allow usage of Perl/CGI, default 0 (false)
dnsenabled
boolether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false)
logviewenabled
boolether to allow acccess to webserver access/error-logs, default 0 (false)
HostingPlans - delete hosting-plan by either id or plan-name
Command HostingPlans.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe hosting-plan-id
planname
stringthe hosting-plan-name
HostingPlans - return a hosting-plan entry by either id or plan-name
Command HostingPlans.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe hosting-plan-id
planname
stringthe hosting-plan-name
HostingPlans - list all available hosting plans
Command HostingPlans.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
HostingPlans - returns the total number of accessable hosting plans
Command HostingPlans.listingCount


Access: admin
Returns string json-encoded array

HostingPlans - update hosting-plan by either id or plan-name
Command HostingPlans.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe hosting-plan-id
planname
stringthe hosting-plan-name
name
stringname of the plan
description
stringdescription for hosting-plan
diskspace
intdisk-space available for customer in MB, default 0
diskspace_ul
boolwhether customer should have unlimited diskspace, default 0 (false)
traffic
inttraffic available for customer in GB, default 0
traffic_ul
boolwhether customer should have unlimited traffic, default 0 (false)
subdomains
intamount of subdomains available for customer, default 0
subdomains_ul
boolwhether customer should have unlimited subdomains, default 0 (false)
emails
intamount of emails available for customer, default 0
emails_ul
boolwhether customer should have unlimited emails, default 0 (false)
email_accounts
intamount of email-accounts available for customer, default 0
email_accounts_ul
boolwhether customer should have unlimited email-accounts, default 0 (false)
email_forwarders
intamount of email-forwarders available for customer, default 0
email_forwarders_ul
boolwhether customer should have unlimited email-forwarders, default 0 (false)
email_quota
intsize of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ul
boolwhether customer should have unlimited email-quota, default 0 (false)
email_imap
boolwhether to allow IMAP access, default 0 (false)
email_pop3
boolwhether to allow POP3 access, default 0 (false)
ftps
intamount of ftp-accounts available for customer, default 0
ftps_ul
boolwhether customer should have unlimited ftp-accounts, default 0 (false)
mysqls
intamount of mysql-databases available for customer, default 0
mysqls_ul
boolwhether customer should have unlimited mysql-databases, default 0 (false)
phpenabled
boolwhether to allow usage of PHP, default 0 (false)
allowed_phpconfigs
arrayarray of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabled
boolwhether to allow usage of Perl/CGI, default 0 (false)
dnsenabled
boolether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false)
logviewenabled
boolether to allow acccess to webserver access/error-logs, default 0 (false)
IpsAndPorts - create a new ip/port entry
Command IpsAndPorts.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
ip
string
port
intdefault 80
listen_statement
booldefault 0 (false)
namevirtualhost_statement
booldefault 0 (false)
vhostcontainer
booldefault 0 (false)
specialsettings
stringdefault empty
vhostcontainer_servername_statement
booldefault 0 (false)
default_vhostconf_domain
stringdefatul empty
docroot
stringdefault empty (point to froxlor)
ssl
booldefault 0 (false)
ssl_cert_file
stringrequires $ssl = 1, default empty
ssl_key_file
stringrequires $ssl = 1, default empty
ssl_ca_file
stringrequires $ssl = 1, default empty
ssl_cert_chainfile
stringrequires $ssl = 1, default empty
ssl_specialsettings
stringrequires $ssl = 1, default empty
include_specialsettings
boolrequires $ssl = 1, whether or not to include non-ssl specialsettings, default false
ssl_default_vhostconf_domain
stringrequires $ssl = 1, defatul empty
include_default_vhostconf_domain
boolrequires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false
IpsAndPorts - delete an ip/port entry by id
Command IpsAndPorts.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intip-port-id
IpsAndPorts - return an ip/port entry by id
Command IpsAndPorts.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intip-port-id
IpsAndPorts - lists all ip/port entries
Command IpsAndPorts.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
IpsAndPorts - returns the total number of accessable ip/port entries
Command IpsAndPorts.listingCount


Access: admin
Returns string json-encoded array

IpsAndPorts - update ip/port entry by given id
Command IpsAndPorts.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
int
ip
string
port
intdefault 80
listen_statement
booldefault 0 (false)
namevirtualhost_statement
booldefault 0 (false)
vhostcontainer
booldefault 0 (false)
specialsettings
stringdefault empty
vhostcontainer_servername_statement
booldefault 0 (false)
default_vhostconf_domain
stringdefatul empty
docroot
stringdefault empty (point to froxlor)
ssl
booldefault 0 (false)
ssl_cert_file
stringrequires $ssl = 1, default empty
ssl_key_file
stringrequires $ssl = 1, default empty
ssl_ca_file
stringrequires $ssl = 1, default empty
ssl_cert_chainfile
stringrequires $ssl = 1, default empty
ssl_specialsettings
stringrequires $ssl = 1, default empty
include_specialsettings
boolrequires $ssl = 1, whether or not to include non-ssl specialsettings, default false
ssl_default_vhostconf_domain
stringrequires $ssl = 1, defatul empty
include_default_vhostconf_domain
boolrequires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false
Mysqls - add a new mysql-database
Command Mysqls.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
mysql_password
stringpassword for the created database and database-user
mysql_server
intdefault is 0
description
stringdescription for database
sendinfomail
boolsend created resource-information to customer, default: false
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
Mysqls - delete a mysql database by either id or dbname
Command Mysqls.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe database-id
dbname
stringthe databasename
mysql_server
intspecify database-server, default is none
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
Mysqls - return a mysql database entry by either id or dbname
Command Mysqls.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe database-id
dbname
stringthe databasename
mysql_server
intspecify database-server, default is none
Mysqls - list all databases, if called from an admin, list all databases of all customers you are allowed to view, or specify id or loginname for one specific customer
Command Mysqls.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
mysql_server
intspecify dbserver to select from, else use all available
customerid
intadmin-only, select dbs of a specific customer by id
loginname
stringadmin-only, select dbs of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
Mysqls - returns the total number of accessable databases
Command Mysqls.listingCount


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, select dbs of a specific customer by id
loginname
stringadmin-only, select dbs of a specific customer by loginname
Mysqls - update a mysql database entry by either id or dbname
Command Mysqls.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe database-id
dbname
stringthe databasename
mysql_server
intspecify database-server, default is none
mysql_password
stringupdate password for the database
description
stringdescription for database
customerid
intadmin-only, the customer-id
loginname
stringadmin-only, the loginname
PhpSettings - add new php-settings entry
Command PhpSettings.add


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
description
stringdescription of the php-config
phpsettings
stringthe actual ini-settings
binary
stringthe binary to php-cgi if FCGID is used
file_extensions
stringallowed php-file-extensions if FCGID is used, default is 'php'
mod_fcgid_starter
intnumber of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequests
intnumber of fcgid-maxrequests if FCGID is used, default is -1
mod_fcgid_umask
stringumask if FCGID is used, default is '022'
fpmconfig
intid of the fpm-daemon-config if FPM is used
phpfpm_enable_slowlog
boolwhether to write a slowlog or not if FPM is used, default is 0 (false)
phpfpm_reqtermtimeout
stringrequest terminate timeout if FPM is used, default is '60s'
phpfpm_reqslowtimeout
stringrequest slowlog timeout if FPM is used, default is '5s'
phpfpm_pass_authorizationheader
boolwhether to pass authorization header to webserver if FPM is used, default is 0 (false)
override_fpmconfig
boolwhether to override fpm-daemon-config value for the following settings if FPM is used, default is 0 (false)
pm
stringprocess-manager to use if FPM is used (allowed values are 'static', 'dynamic' and 'ondemand'), default is fpm-daemon-value
max_children
intnumber of max children if FPM is used, default is the fpm-daemon-value
start_server
intnumber of servers to start if FPM is used, default is fpm-daemon-value
min_spare_servers
intnumber of minimum spare servers if FPM is used, default is fpm-daemon-value
max_spare_servers
intnumber of maximum spare servers if FPM is used, default is fpm-daemon-value
max_requests
intnumber of maximum requests if FPM is used, default is fpm-daemon-value
idle_timeout
intnumber of seconds for idle-timeout if FPM is used, default is fpm-daemon-value
limit_extensions
stringlimitation of php-file-extensions if FPM is used, default is fpm-daemon-value
PhpSettings - delete a php-setting entry by id
Command PhpSettings.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intphp-settings-id
PhpSettings - return a php-setting entry by id
Command PhpSettings.get


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intphp-settings-id
PhpSettings - lists all php-setting entries
Command PhpSettings.listing


Access: admin
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
with_subdomains
boolalso include subdomains to the list domains that use the config, default 0 (false)
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
PhpSettings - returns the total number of accessable php-setting entries
Command PhpSettings.listingCount


Access: admin
Returns string json-encoded array

PhpSettings - update a php-setting entry by given id
Command PhpSettings.update


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
id
int
description
stringdescription of the php-config
phpsettings
stringthe actual ini-settings
binary
stringthe binary to php-cgi if FCGID is used
file_extensions
stringallowed php-file-extensions if FCGID is used, default is 'php'
mod_fcgid_starter
intnumber of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequests
intnumber of fcgid-maxrequests if FCGID is used, default is -1
mod_fcgid_umask
stringumask if FCGID is used, default is '022'
fpmconfig
intid of the fpm-daemon-config if FPM is used
phpfpm_enable_slowlog
boolwhether to write a slowlog or not if FPM is used, default is 0 (false)
phpfpm_reqtermtimeout
stringrequest terminate timeout if FPM is used, default is '60s'
phpfpm_reqslowtimeout
stringrequest slowlog timeout if FPM is used, default is '5s'
phpfpm_pass_authorizationheader
boolwhether to pass authorization header to webserver if FPM is used, default is 0 (false)
override_fpmconfig
boolwhether to override fpm-daemon-config value for the following settings if FPM is used, default is 0 (false)
pm
stringprocess-manager to use if FPM is used (allowed values are 'static', 'dynamic' and 'ondemand'), default is fpm-daemon-value
max_children
intnumber of max children if FPM is used, default is the fpm-daemon-value
start_server
intnumber of servers to start if FPM is used, default is fpm-daemon-value
min_spare_servers
intnumber of minimum spare servers if FPM is used, default is fpm-daemon-value
max_spare_servers
intnumber of maximum spare servers if FPM is used, default is fpm-daemon-value
max_requests
intnumber of maximum requests if FPM is used, default is fpm-daemon-value
idle_timeout
intnumber of seconds for idle-timeout if FPM is used, default is fpm-daemon-value
limit_extensions
stringlimitation of php-file-extensions if FPM is used, default is fpm-daemon-value
SubDomains - add a new subdomain
Command SubDomains.add


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
subdomain
stringpart before domain.tld to create as subdomain
domain
stringdomainname of main-domain
alias
intdomain-id of a domain that the new domain should be an alias of
path
stringdestination path relative to the customers-homedir, default is customers-homedir
url
stringoverwrites path value with an URL to generate a redirect, alternatively use the path parameter also for URLs
openbasedir_path
inteither 0 for customers-homedir or 1 for domains-docroot
phpsettingid
intphp-settings-id, if empty the $domain value is used
redirectcode
intredirect-code-id from TABLE_PANEL_REDIRECTCODES
ssl_redirect
boolwhether to generate a https-redirect or not, default false; requires SSL to be enabled
letsencrypt
boolwhether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled
http2
boolwhether to enable http/2 for this subdomain (requires to be enabled in the settings), default 0 (false)
hsts_maxage
intmax-age value for HSTS header, default 0
hsts_sub
boolwhether or not to add subdomains to the HSTS header, default 0
hsts_preload
boolwhether or not to preload HSTS header value, default 0
customerid
intrequired when called as admin, not needed when called as customer
SubDomains - delete a subdomain by either id or domainname
Command SubDomains.delete


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
SubDomains - return a subdomain entry by either id or domainname
Command SubDomains.get


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
SubDomains - lists all subdomain entries
Command SubDomains.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
customerid
intadmin-only, select (sub)domains of a specific customer by id
loginname
stringadmin-only, select (sub)domains of a specific customer by loginname
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
SubDomains - returns the total number of accessable subdomain entries
Command SubDomains.listingCount


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
customerid
intadmin-only, select (sub)domains of a specific customer by id
loginname
stringadmin-only, select (sub)domains of a specific customer by loginname
SubDomains - update subdomain entry by either id or domainname
Command SubDomains.update


Access: admin, customer
Returns string json-encoded array

Parameter

FieldTypeDescription
id
intthe domain-id
domainname
stringthe domainname
alias
intdomain-id of a domain that the new domain should be an alias of
path
stringdestination path relative to the customers-homedir, default is customers-homedir
url
stringoverwrites path value with an URL to generate a redirect, alternatively use the path parameter also for URLs
selectserveralias
int0 = wildcard, 1 = www-alias, 2 = none
isemaildomain
bool
openbasedir_path
inteither 0 for customers-homedir or 1 for domains-docroot
phpsettingid
intphp-settings-id, if empty the $domain value is used
redirectcode
intredirect-code-id from TABLE_PANEL_REDIRECTCODES
ssl_redirect
boolwhether to generate a https-redirect or not, default false; requires SSL to be enabled
letsencrypt
boolwhether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled
http2
boolwhether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false)
hsts_maxage
intmax-age value for HSTS header
hsts_sub
boolwhether or not to add subdomains to the HSTS header
hsts_preload
boolwhether or not to preload HSTS header value
customerid
intrequired when called as admin, not needed when called as customer
SysLog - You cannot add log entries
Command SysLog.add

Returns no-return-type

SysLog - delete log entries
Command SysLog.delete


Access: admin
Returns string json-encoded array

Parameter

FieldTypeDescription
min_to_keep
intminutes to keep, default is 10
SysLog - You cannot get log entries
Command SysLog.get

Returns no-return-type

SysLog - list all log-entries
Command SysLog.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
sql_search
arrayarray with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue
sql_limit
intspecify number of results to be returned
sql_offset
intspecify offset for resultset
sql_orderby
arrayarray with index = fieldname and value = ASC|DESC to order the resultset by one or more fields
SysLog - returns the total number of log-entries
Command SysLog.listingCount


Access: admin
Returns string json-encoded array

SysLog - You cannot update log entries
Command SysLog.update

Returns no-return-type

Traffic - You cannot add traffic data
Command Traffic.add

Returns no-return-type

Traffic - You cannot delete traffic data
Command Traffic.delete

Returns no-return-type

Traffic - to get specific traffic details use year, month and/or day parameter for Traffic.listing()
Command Traffic.get

Returns no-return-type

Traffic - list traffic information
Command Traffic.listing


Access: admin, customer
Returns string json-encoded array count|list

Parameter

FieldTypeDescription
year
intdefault empty
month
intdefault empty
day
intdefault empty
customer_traffic
booladmin-only, whether to output ones own traffic or all of ones customers, default is 0 (false)
customerid
intadmin-only, select traffic of a specific customer by id
loginname
stringadmin-only, select traffic of a specific customer by loginname
Traffic - You cannot count the traffic data list
Command Traffic.listingCount

Returns no-return-type

Traffic - You cannot update traffic data
Command Traffic.update

Returns no-return-type