Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
name | string | |
string | ||
new_loginname | string | |
admin_password | string | default auto-generated |
def_language | string | default is system-default language |
api_allowed | bool | default is true if system setting api.enabled is true, else false |
custom_notes | string | default empty |
custom_notes_show | bool | default false |
diskspace | int | default 0 |
diskspace_ul | bool | default false |
traffic | int | default 0 |
traffic_ul | bool | default false |
customers | int | default 0 |
customers_ul | bool | default false |
domains | int | default 0 |
domains_ul | bool | default false |
subdomains | int | default 0 |
subdomains_ul | bool | default false |
emails | int | default 0 |
emails_ul | bool | default false |
email_accounts | int | default 0 |
email_accounts_ul | bool | default false |
email_forwarders | int | default 0 |
email_forwarders_ul | bool | default false |
email_quota | int | default 0 |
email_quota_ul | bool | default false |
ftps | int | default 0 |
ftps_ul | bool | default false |
mysqls | int | default 0 |
mysqls_ul | bool | default false |
customers_see_all | bool | default false |
domains_see_all | bool | default false |
caneditphpsettings | bool | default false |
change_serversettings | bool | default false |
ipaddress | array | list of ip-address id's; default -1 (all IP's) |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the admin-id |
loginname | string | the loginname |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the admin-id |
loginname | string | the loginname |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the admin-id |
loginname | string | the loginname |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the admin-id |
loginname | string | the loginname |
name | string | |
string | ||
admin_password | string | default auto-generated |
def_language | string | default is system-default language |
api_allowed | bool | default is true if system setting api.enabled is true, else false |
custom_notes | string | default empty |
theme | string | |
deactivated | bool | default false |
custom_notes_show | bool | default false |
diskspace | int | default 0 |
diskspace_ul | bool | default false |
traffic | int | default 0 |
traffic_ul | bool | default false |
customers | int | default 0 |
customers_ul | bool | default false |
domains | int | default 0 |
domains_ul | bool | default false |
subdomains | int | default 0 |
subdomains_ul | bool | default false |
emails | int | default 0 |
emails_ul | bool | default false |
email_accounts | int | default 0 |
email_accounts_ul | bool | default false |
email_forwarders | int | default 0 |
email_forwarders_ul | bool | default false |
email_quota | int | default 0 |
email_quota_ul | bool | default false |
ftps | int | default 0 |
ftps_ul | bool | default false |
mysqls | int | default 0 |
mysqls_ul | bool | default false |
customers_see_all | bool | default false |
domains_see_all | bool | default false |
caneditphpsettings | bool | default false |
change_serversettings | bool | default false |
ipaddress | array | list of ip-address id's; default -1 (all IP's) |
Returns no-return-type
Returns no-return-type
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
ssl_cert_file | string | |
ssl_key_file | string | |
ssl_ca_file | string | |
ssl_cert_chainfile | string |
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
ssl_cert_file | string | |
ssl_key_file | string | |
ssl_ca_file | string | |
ssl_cert_chainfile | string |
Returns no-return-type
Returns no-return-type
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | cronjob-id |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | |
isactive | bool | whether the cronjob is active or not |
interval_value | int | number of seconds/minutes/hours/etc. for the interval |
interval_interval | string | interval for the cronjob (MINUTE, HOUR, DAY, WEEK or MONTH) |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
path | string | path to store the backup to |
backup_dbs | bool | whether to backup databases, default is 0 (false) |
backup_mail | bool | whether to backup mail-data, default is 0 (false) |
backup_web | bool | whether to backup web-data, default is 0 (false) |
customerid | int | required when called as admin, not needed when called as customer |
Access: admin, customer
Returns bool
Parameter
Field | Type | Description |
---|---|---|
backup_job_entry | int | id of backup job |
customerid | int | required when called as admin (if $loginname is not specified) |
loginname | string | required when called as admin (if $customerid is not specified) |
Returns no-return-type
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select backup-jobs of a specific customer by id |
loginname | string | admin-only, select backup-jobs of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select backup-jobs of a specific customer by id |
loginname | string | admin-only, select backup-jobs of a specific customer by loginname |
Returns no-return-type
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
string | ||
name | string | if company is set, else required |
firstname | string | if company is set, else required |
company | string | but required if name/firstname empty |
street | string | |
zipcode | string | |
city | string | |
phone | string | |
fax | string | |
customernumber | int | |
def_language | string | default is system-default language |
api_allowed | bool | default is true if system setting api.enabled is true, else false |
gender | int | 0 = no-gender, 1 = male, 2 = female |
custom_notes | string | notes |
custom_notes_show | bool | whether to show the content of custom_notes to the customer, default 0 (false) |
new_loginname | string | if empty generated automatically using customer-prefix and increasing number |
new_customer_password | string | if empty generated automatically and send to the customer's email if $sendpassword is 1 |
sendpassword | bool | whether to send the password to the customer after creation, default 0 (false) |
diskspace | int | disk-space available for customer in MB, default 0 |
diskspace_ul | bool | whether customer should have unlimited diskspace, default 0 (false) |
traffic | int | traffic available for customer in GB, default 0 |
traffic_ul | bool | whether customer should have unlimited traffic, default 0 (false) |
subdomains | int | amount of subdomains available for customer, default 0 |
subdomains_ul | bool | whether customer should have unlimited subdomains, default 0 (false) |
emails | int | amount of emails available for customer, default 0 |
emails_ul | bool | whether customer should have unlimited emails, default 0 (false) |
email_accounts | int | amount of email-accounts available for customer, default 0 |
email_accounts_ul | bool | whether customer should have unlimited email-accounts, default 0 (false) |
email_forwarders | int | amount of email-forwarders available for customer, default 0 |
email_forwarders_ul | bool | whether customer should have unlimited email-forwarders, default 0 (false) |
email_quota | int | size of email-quota available for customer in MB, default is system-setting mail_quota |
email_quota_ul | bool | whether customer should have unlimited email-quota, default 0 (false) |
email_imap | bool | whether to allow IMAP access, default 0 (false) |
email_pop3 | bool | whether to allow POP3 access, default 0 (false) |
ftps | int | amount of ftp-accounts available for customer, default 0 |
ftps_ul | bool | whether customer should have unlimited ftp-accounts, default 0 (false) |
mysqls | int | amount of mysql-databases available for customer, default 0 |
mysqls_ul | bool | whether customer should have unlimited mysql-databases, default 0 (false) |
createstdsubdomain | bool | whether to create a standard-subdomain ([loginname].froxlor-hostname.tld), default 0 (false) |
phpenabled | bool | whether to allow usage of PHP, default 0 (false) |
allowed_phpconfigs | array | array of IDs of php-config that the customer is allowed to use, default empty (none) |
perlenabled | bool | whether to allow usage of Perl/CGI, default 0 (false) |
dnsenabled | bool | wether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false) |
logviewenabled | bool | wether to allow acccess to webserver access/error-logs, default 0 (false) |
store_defaultindex | bool | whether to store the default index file to customers homedir |
hosting_plan_id | int | specify a hosting-plan to set certain resource-values from the plan instead of specifying them |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
loginname | string | the loginname |
delete_userfiles | bool | default false |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
loginname | string | the loginname |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
loginname | string | the loginname |
adminid | int | target-admin-id |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
loginname | string | the loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
loginname | string | the loginname |
string | ||
name | string | if company is set, else required |
firstname | string | if company is set, else required |
company | string | but required if name/firstname empty |
street | string | |
zipcode | string | |
city | string | |
phone | string | |
fax | string | |
customernumber | int | |
def_language | string | default is system-default language |
api_allowed | bool | default is true if system setting api.enabled is true, else false |
gender | int | 0 = no-gender, 1 = male, 2 = female |
custom_notes | string | notes |
custom_notes_show | bool | whether to show the content of custom_notes to the customer, default 0 (false) |
new_customer_password | string | iset new password |
sendpassword | bool | whether to send the password to the customer after creation, default 0 (false) |
move_to_admin | int | if valid admin-id is given here, the customer's admin/reseller can be changed |
deactivated | bool | if 1 (true) the customer can be deactivated/suspended |
diskspace | int | disk-space available for customer in MB, default 0 |
diskspace_ul | bool | whether customer should have unlimited diskspace, default 0 (false) |
traffic | int | traffic available for customer in GB, default 0 |
traffic_ul | bool | whether customer should have unlimited traffic, default 0 (false) |
subdomains | int | amount of subdomains available for customer, default 0 |
subdomains_ul | bool | whether customer should have unlimited subdomains, default 0 (false) |
emails | int | amount of emails available for customer, default 0 |
emails_ul | bool | whether customer should have unlimited emails, default 0 (false) |
email_accounts | int | amount of email-accounts available for customer, default 0 |
email_accounts_ul | bool | whether customer should have unlimited email-accounts, default 0 (false) |
email_forwarders | int | amount of email-forwarders available for customer, default 0 |
email_forwarders_ul | bool | whether customer should have unlimited email-forwarders, default 0 (false) |
email_quota | int | size of email-quota available for customer in MB, default is system-setting mail_quota |
email_quota_ul | bool | whether customer should have unlimited email-quota, default 0 (false) |
email_imap | bool | whether to allow IMAP access, default 0 (false) |
email_pop3 | bool | whether to allow POP3 access, default 0 (false) |
ftps | int | amount of ftp-accounts available for customer, default 0 |
ftps_ul | bool | whether customer should have unlimited ftp-accounts, default 0 (false) |
mysqls | int | amount of mysql-databases available for customer, default 0 |
mysqls_ul | bool | whether customer should have unlimited mysql-databases, default 0 (false) |
createstdsubdomain | bool | whether to create a standard-subdomain ([loginname].froxlor-hostname.tld), default 0 (false) |
phpenabled | bool | whether to allow usage of PHP, default 0 (false) |
allowed_phpconfigs | array | array of IDs of php-config that the customer is allowed to use, default empty (none) |
perlenabled | bool | whether to allow usage of Perl/CGI, default 0 (false) |
dnsenabled | bool | ether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false) |
logviewenabled | bool | ether to allow acccess to webserver access/error-logs, default 0 (false) |
theme | string | change theme |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
path | string | path relative to the customer's home-Directory |
options_indexes | bool | activate directory-listing for this path, default 0 (false) |
options_cgi | bool | allow Perl/CGI execution, default 0 (false) |
error404path | string | custom 404 error string/file |
error403path | string | custom 403 error string/file |
error500path | string | custom 500 error string/file |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | id of dir-protection entry |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | id of dir-protection entry |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select directory-protections of a specific customer by id |
loginname | string | admin-only, select directory-protections of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select directory-protections of a specific customer by id |
loginname | string | admin-only, select directory-protections of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | id of dir-protection entry |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
options_indexes | bool | activate directory-listing for this path, default 0 (false) |
options_cgi | bool | allow Perl/CGI execution, default 0 (false) |
error404path | string | custom 404 error string/file |
error403path | string | custom 403 error string/file |
error500path | string | custom 500 error string/file |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
path | string | |
username | string | |
directory_password | string | |
directory_authname | string | name/description for the protection |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the directory-protection-id |
username | string | the username |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the directory-protection-id |
username | string | the username |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select directory-protections of a specific customer by id |
loginname | string | admin-only, select directory-protections of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select directory-protections of a specific customer by id |
loginname | string | admin-only, select directory-protections of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the directory-protection-id |
username | string | the username |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
directory_password | string | leave empty for no change |
directory_authname | string | name/description for the protection |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | domain id |
domainname | string | domain name |
record | string | default empty |
type | string | zone-entry type (A, AAAA, TXT, etc.), default 'A' |
prio | int | priority, default empty |
content | string | default empty |
ttl | int | default 18000 |
Access: admin, customer
Returns bool
Parameter
Field | Type | Description |
---|---|---|
entry_id | int | |
id | int | the domain id |
domainname | string | the domain name |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain id |
domainname | string | the domain name |
Access: admin, customer
Returns bool
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain id |
domainname | string | the domain name |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns bool
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain id |
domainname | string | the domain name |
Returns no-return-type
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
domain | string | domain-name |
customerid | int | |
adminid | int | default is the calling admin's ID |
ipandport | array | list of ip/ports to assign to domain, default is system-default-ips |
subcanemaildomain | int | allow subdomains of this domain as email domains, 1 = choosable (default no), 2 = choosable (default yes), 3 = always, default 0 (never) |
isemaildomain | bool | allow email usage with this domain, default 0 (false) |
email_only | bool | restrict domain to email usage, default 0 (false) |
selectserveralias | int | 0 = wildcard, 1 = www-alias, 2 = none, default 0 |
speciallogfile | bool | whether to create an exclusive web-logfile for this domain, default 0 (false) |
alias | int | domain-id of a domain that the new domain should be an alias of, default 0 (none) |
issubof | bool | domain-id of a domain this domain is a subdomain of (required for webserver-cronjob to generate the correct order), default 0 (none) |
registration_date | string | date of domain registration in form of YYYY-MM-DD, default empty (none) |
termination_date | string | date of domain termination in form of YYYY-MM-DD, default empty (none) |
caneditdomain | bool | whether to allow the customer to edit domain settings, default 0 (false) |
isbinddomain | bool | whether to generate a dns-zone or not (only of nameserver is activated), default 0 (false) |
zonefile | string | custom dns zone filename (only of nameserver is activated), default empty (auto-generated) |
dkim | bool | currently not in use, default 0 (false) |
specialsettings | string | custom webserver vhost-content which is added to the generated vhost, default empty |
ssl_specialsettings | string | custom webserver vhost-content which is added to the generated ssl-vhost, default empty |
include_specialsettings | bool | whether 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 | bool | Enable writing an access-log file for this domain, default 1 (true) |
writeerrorlog | bool | Enable writing an error-log file for this domain, default 1 (true) |
documentroot | string | specify 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 | bool | whether php is enabled for this domain, default 0 (false) |
openbasedir | bool | whether to activate openbasedir restriction for this domain, default 0 (false) |
phpsettingid | int | specify php-configuration that is being used by id, default 1 (system-default) |
mod_fcgid_starter | int | number of fcgid-starters if FCGID is used, default is -1 |
mod_fcgid_maxrequests | int | number of fcgid-maxrequests if FCGID is used, default is -1 |
ssl_redirect | bool | whether to generate a https-redirect or not, default false; requires SSL to be enabled |
letsencrypt | bool | whether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled |
ssl_ipandport | array | list of ssl-enabled ip/port id's to assign to this domain, default empty |
dont_use_default_ssl_ipandport_if_empty | bool | do NOT set the systems default ssl ip addresses if none are given via $ssl_ipandport parameter |
sslenabled | bool | whether or not SSL is enabled for this domain, regardless of the assigned ssl-ips, default 1 (true) |
http2 | bool | whether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false) |
hsts_maxage | int | max-age value for HSTS header |
hsts_sub | bool | whether or not to add subdomains to the HSTS header |
hsts_preload | bool | whether or not to preload HSTS header value |
ocsp_stapling | bool | whether to enable ocsp-stapling for this domain. default 0 (false), requires SSL |
honorcipherorder | bool | whether to honor the (server) cipher order for this domain. default 0 (false), requires SSL |
sessiontickets | bool | whether to enable or disable TLS sessiontickets (RFC 5077) for this domain. default 1 (true), requires SSL |
override_tls | bool | whether 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 | array | list 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 | string | list 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 | string | list 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 |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
delete_mainsubdomains | bool | remove also domains that are subdomains of this domain but added as main domains; default false |
is_stdsubdomain | bool | default false, specify whether it's a std-subdomain you are deleting as it does not count as subdomain-resource |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
with_ips | bool | default true |
no_std_subdomain | bool | default false |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
with_ips | bool | default true |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array count|list
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
customerid | int | customer-id |
adminid | int | default is the calling admin's ID |
ipandport | array | list of ip/ports to assign to domain, default is system-default-ips |
subcanemaildomain | int | allow subdomains of this domain as email domains, 1 = choosable (default no), 2 = choosable (default yes), 3 = always, default 0 (never) |
isemaildomain | bool | allow email usage with this domain, default 0 (false) |
email_only | bool | restrict domain to email usage, default 0 (false) |
selectserveralias | int | 0 = wildcard, 1 = www-alias, 2 = none, default 0 |
speciallogfile | bool | whether to create an exclusive web-logfile for this domain, default 0 (false) |
speciallogverified | bool | when setting $speciallogfile to false, this needs to be set to true to confirm the action, default 0 (false) |
alias | int | domain-id of a domain that the new domain should be an alias of, default 0 (none) |
issubof | bool | domain-id of a domain this domain is a subdomain of (required for webserver-cronjob to generate the correct order), default 0 (none) |
registration_date | string | date of domain registration in form of YYYY-MM-DD, default empty (none) |
termination_date | string | date of domain termination in form of YYYY-MM-DD, default empty (none) |
caneditdomain | bool | whether to allow the customer to edit domain settings, default 0 (false) |
isbinddomain | bool | whether to generate a dns-zone or not (only of nameserver is activated), default 0 (false) |
zonefile | string | custom dns zone filename (only of nameserver is activated), default empty (auto-generated) |
dkim | bool | currently not in use, default 0 (false) |
specialsettings | string | custom webserver vhost-content which is added to the generated vhost, default empty |
ssl_specialsettings | string | custom webserver vhost-content which is added to the generated ssl-vhost, default empty |
include_specialsettings | bool | whether or not to include non-ssl specialsettings in the generated ssl-vhost, default false |
specialsettingsforsubdomains | bool | whether 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 | bool | Enable writing an access-log file for this domain, default 1 (true) |
writeerrorlog | bool | Enable writing an error-log file for this domain, default 1 (true) |
documentroot | string | specify 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 | bool | whether php is enabled for this domain, default 0 (false) |
phpsettingsforsubdomains | bool | whether to apply php-setting to apply to all subdomains of this domain, default is read from setting system.apply_phpconfigs_default |
openbasedir | bool | whether to activate openbasedir restriction for this domain, default 0 (false) |
phpsettingid | int | specify php-configuration that is being used by id, default 1 (system-default) |
mod_fcgid_starter | int | number of fcgid-starters if FCGID is used, default is -1 |
mod_fcgid_maxrequests | int | number of fcgid-maxrequests if FCGID is used, default is -1 |
ssl_redirect | bool | whether to generate a https-redirect or not, default false; requires SSL to be enabled |
letsencrypt | bool | whether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled |
ssl_ipandport | array | list 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 | bool | if set to true and no $ssl_ipandport value is given, the ip's get removed, otherwise, the currently set value is used, default false |
sslenabled | bool | whether or not SSL is enabled for this domain, regardless of the assigned ssl-ips, default 1 (true) |
http2 | bool | whether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false) |
hsts_maxage | int | max-age value for HSTS header |
hsts_sub | bool | whether or not to add subdomains to the HSTS header |
hsts_preload | bool | whether or not to preload HSTS header value |
ocsp_stapling | bool | whether to enable ocsp-stapling for this domain. default 0 (false), requires SSL |
honorcipherorder | bool | whether to honor the (server) cipher order for this domain. default 0 (false), requires SSL |
sessiontickets | bool | whether to enable or disable TLS sessiontickets (RFC 5077) for this domain. default 1 (true), requires SSL |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | email-address-id of email-address to add the account for |
emailaddr | string | email-address to add the account for |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
email_password | string | password for the account |
alternative_email | string | email address to send account information to, default is the account that is being created |
email_quota | int | quota if enabled in MB, default 0 |
sendinfomail | bool | sends 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) |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to delete the account for |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
delete_userfiles | bool | default false |
Returns no-return-type
Returns no-return-type
Returns no-return-type
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to update |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
email_quota | int | update quota |
email_password | string | update password |
Access: admin,customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to add the forwarder for |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
destination | string | email-address to add as forwarder |
Access: admin,customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to delete the forwarder from |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
forwarderid | int | id of the forwarder to delete |
Returns no-return-type
Access: admin,customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to delete the forwarder from |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Access: admin,customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address to delete the forwarder from |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Returns no-return-type
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
email_part | string | name of the address before @ |
domain | string | domain-name for the email-address |
iscatchall | boolean | make this address a catchall address, default: no |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
delete_userfiles | boolean | delete email data from filesystem, default: 0 (false) |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select email addresses of a specific customer by id |
loginname | string | admin-only, select email addresses of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select email addresses of a specific customer by id |
loginname | string | admin-only, select email addresses of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the email-address-id |
emailaddr | string | the email-address |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
iscatchall | boolean |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
description | string | |
reload_cmd | string | |
config_dir | string | |
pm | string | process-manager, one of 'static', 'dynamic' or 'ondemand', default 'dynamic' |
max_children | int | default 5 |
start_servers | int | default 2 |
min_spare_servers | int | default 1 |
max_spare_servers | int | default 3 |
max_requests | int | default 0 |
idle_timeout | int | default 10 |
limit_extensions | string | limit execution to the following extensions, default '.php' |
custom_config | string | custom settings appended to phpfpm pool configuration |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | fpm-daemon-id |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | fpm-daemon-id |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | fpm-daemon id |
description | string | |
reload_cmd | string | |
config_dir | string | |
pm | string | process-manager, one of 'static', 'dynamic' or 'ondemand', default 'dynamic' |
max_children | int | default 5 |
start_servers | int | default 2 |
min_spare_servers | int | default 1 |
max_spare_servers | int | default 3 |
max_requests | int | default 0 |
idle_timeout | int | default 10 |
limit_extensions | string | limit execution to the following extensions, default '.php' |
custom_config | string | custom settings appended to phpfpm pool configuration |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-string
Access: admin, customer
Returns string
Access: admin
Returns string
Parameter
Field | Type | Description |
---|---|---|
key | string | settinggroup.varname couple |
Access: admin
Returns string json-encoded bool
Parameter
Field | Type | Description |
---|---|---|
json_str | string | content of exported froxlor-settings json file |
Access: admin
Returns string
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
module | string | return list of functions for a specific module |
Access: admin
Returns string json-encoded array count|list
Access: admin
Returns string
Parameter
Field | Type | Description |
---|---|---|
key | string | settinggroup.varname couple |
value | string | the new value, default is '' |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
ftp_password | string | password for the created database and database-user |
path | string | destination path relative to the customers-homedir |
ftp_description | string | description for ftp-user |
sendinfomail | bool | send created resource-information to customer, default: false |
shell | string | default /bin/false (not changeable when deactivated) |
ftp_username | string | if customer.ftpatdomain is allowed, specify an username |
ftp_domain | string | if customer.ftpatdomain is allowed, specify a domain (customer must be owner) |
customerid | int | required when called as admin, not needed when called as customer |
additional_members | array | whether to add additional usernames to the group |
is_defaultuser | bool | whether this is the standard default ftp user which is being added so no usage is decreased |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the ftp-user-id |
username | string | the username |
delete_userfiles | bool | default false |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the customer-id |
username | string | the username |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select ftp-users of a specific customer by id |
loginname | string | admin-only, select ftp-users of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select ftp-users of a specific customer by id |
loginname | string | admin-only, select ftp-users of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the ftp-user-id |
username | string | the username |
ftp_password | string | password for the created database and database-user |
path | string | destination path relative to the customers-homedir |
ftp_description | string | description for ftp-user |
shell | string | default /bin/false (not changeable when deactivated) |
customerid | int | required when called as admin, not needed when called as customer |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
name | string | name of the plan |
description | string | description for hosting-plan |
diskspace | int | disk-space available for customer in MB, default 0 |
diskspace_ul | bool | whether customer should have unlimited diskspace, default 0 (false) |
traffic | int | traffic available for customer in GB, default 0 |
traffic_ul | bool | whether customer should have unlimited traffic, default 0 (false) |
subdomains | int | amount of subdomains available for customer, default 0 |
subdomains_ul | bool | whether customer should have unlimited subdomains, default 0 (false) |
emails | int | amount of emails available for customer, default 0 |
emails_ul | bool | whether customer should have unlimited emails, default 0 (false) |
email_accounts | int | amount of email-accounts available for customer, default 0 |
email_accounts_ul | bool | whether customer should have unlimited email-accounts, default 0 (false) |
email_forwarders | int | amount of email-forwarders available for customer, default 0 |
email_forwarders_ul | bool | whether customer should have unlimited email-forwarders, default 0 (false) |
email_quota | int | size of email-quota available for customer in MB, default is system-setting mail_quota |
email_quota_ul | bool | whether customer should have unlimited email-quota, default 0 (false) |
email_imap | bool | whether to allow IMAP access, default 0 (false) |
email_pop3 | bool | whether to allow POP3 access, default 0 (false) |
ftps | int | amount of ftp-accounts available for customer, default 0 |
ftps_ul | bool | whether customer should have unlimited ftp-accounts, default 0 (false) |
mysqls | int | amount of mysql-databases available for customer, default 0 |
mysqls_ul | bool | whether customer should have unlimited mysql-databases, default 0 (false) |
phpenabled | bool | whether to allow usage of PHP, default 0 (false) |
allowed_phpconfigs | array | array of IDs of php-config that the customer is allowed to use, default empty (none) |
perlenabled | bool | whether to allow usage of Perl/CGI, default 0 (false) |
dnsenabled | bool | ether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false) |
logviewenabled | bool | ether to allow acccess to webserver access/error-logs, default 0 (false) |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the hosting-plan-id |
planname | string | the hosting-plan-name |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the hosting-plan-id |
planname | string | the hosting-plan-name |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the hosting-plan-id |
planname | string | the hosting-plan-name |
name | string | name of the plan |
description | string | description for hosting-plan |
diskspace | int | disk-space available for customer in MB, default 0 |
diskspace_ul | bool | whether customer should have unlimited diskspace, default 0 (false) |
traffic | int | traffic available for customer in GB, default 0 |
traffic_ul | bool | whether customer should have unlimited traffic, default 0 (false) |
subdomains | int | amount of subdomains available for customer, default 0 |
subdomains_ul | bool | whether customer should have unlimited subdomains, default 0 (false) |
emails | int | amount of emails available for customer, default 0 |
emails_ul | bool | whether customer should have unlimited emails, default 0 (false) |
email_accounts | int | amount of email-accounts available for customer, default 0 |
email_accounts_ul | bool | whether customer should have unlimited email-accounts, default 0 (false) |
email_forwarders | int | amount of email-forwarders available for customer, default 0 |
email_forwarders_ul | bool | whether customer should have unlimited email-forwarders, default 0 (false) |
email_quota | int | size of email-quota available for customer in MB, default is system-setting mail_quota |
email_quota_ul | bool | whether customer should have unlimited email-quota, default 0 (false) |
email_imap | bool | whether to allow IMAP access, default 0 (false) |
email_pop3 | bool | whether to allow POP3 access, default 0 (false) |
ftps | int | amount of ftp-accounts available for customer, default 0 |
ftps_ul | bool | whether customer should have unlimited ftp-accounts, default 0 (false) |
mysqls | int | amount of mysql-databases available for customer, default 0 |
mysqls_ul | bool | whether customer should have unlimited mysql-databases, default 0 (false) |
phpenabled | bool | whether to allow usage of PHP, default 0 (false) |
allowed_phpconfigs | array | array of IDs of php-config that the customer is allowed to use, default empty (none) |
perlenabled | bool | whether to allow usage of Perl/CGI, default 0 (false) |
dnsenabled | bool | ether to allow usage of the DNS editor (requires activated nameserver in settings), default 0 (false) |
logviewenabled | bool | ether to allow acccess to webserver access/error-logs, default 0 (false) |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
ip | string | |
port | int | default 80 |
listen_statement | bool | default 0 (false) |
namevirtualhost_statement | bool | default 0 (false) |
vhostcontainer | bool | default 0 (false) |
specialsettings | string | default empty |
vhostcontainer_servername_statement | bool | default 0 (false) |
default_vhostconf_domain | string | defatul empty |
docroot | string | default empty (point to froxlor) |
ssl | bool | default 0 (false) |
ssl_cert_file | string | requires $ssl = 1, default empty |
ssl_key_file | string | requires $ssl = 1, default empty |
ssl_ca_file | string | requires $ssl = 1, default empty |
ssl_cert_chainfile | string | requires $ssl = 1, default empty |
ssl_specialsettings | string | requires $ssl = 1, default empty |
include_specialsettings | bool | requires $ssl = 1, whether or not to include non-ssl specialsettings, default false |
ssl_default_vhostconf_domain | string | requires $ssl = 1, defatul empty |
include_default_vhostconf_domain | bool | requires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | ip-port-id |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | ip-port-id |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | |
ip | string | |
port | int | default 80 |
listen_statement | bool | default 0 (false) |
namevirtualhost_statement | bool | default 0 (false) |
vhostcontainer | bool | default 0 (false) |
specialsettings | string | default empty |
vhostcontainer_servername_statement | bool | default 0 (false) |
default_vhostconf_domain | string | defatul empty |
docroot | string | default empty (point to froxlor) |
ssl | bool | default 0 (false) |
ssl_cert_file | string | requires $ssl = 1, default empty |
ssl_key_file | string | requires $ssl = 1, default empty |
ssl_ca_file | string | requires $ssl = 1, default empty |
ssl_cert_chainfile | string | requires $ssl = 1, default empty |
ssl_specialsettings | string | requires $ssl = 1, default empty |
include_specialsettings | bool | requires $ssl = 1, whether or not to include non-ssl specialsettings, default false |
ssl_default_vhostconf_domain | string | requires $ssl = 1, defatul empty |
include_default_vhostconf_domain | bool | requires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
mysql_password | string | password for the created database and database-user |
mysql_server | int | default is 0 |
description | string | description for database |
sendinfomail | bool | send created resource-information to customer, default: false |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the database-id |
dbname | string | the databasename |
mysql_server | int | specify database-server, default is none |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the database-id |
dbname | string | the databasename |
mysql_server | int | specify database-server, default is none |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
mysql_server | int | specify dbserver to select from, else use all available |
customerid | int | admin-only, select dbs of a specific customer by id |
loginname | string | admin-only, select dbs of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select dbs of a specific customer by id |
loginname | string | admin-only, select dbs of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the database-id |
dbname | string | the databasename |
mysql_server | int | specify database-server, default is none |
mysql_password | string | update password for the database |
description | string | description for database |
customerid | int | admin-only, the customer-id |
loginname | string | admin-only, the loginname |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
description | string | description of the php-config |
phpsettings | string | the actual ini-settings |
binary | string | the binary to php-cgi if FCGID is used |
file_extensions | string | allowed php-file-extensions if FCGID is used, default is 'php' |
mod_fcgid_starter | int | number of fcgid-starters if FCGID is used, default is -1 |
mod_fcgid_maxrequests | int | number of fcgid-maxrequests if FCGID is used, default is -1 |
mod_fcgid_umask | string | umask if FCGID is used, default is '022' |
fpmconfig | int | id of the fpm-daemon-config if FPM is used |
phpfpm_enable_slowlog | bool | whether to write a slowlog or not if FPM is used, default is 0 (false) |
phpfpm_reqtermtimeout | string | request terminate timeout if FPM is used, default is '60s' |
phpfpm_reqslowtimeout | string | request slowlog timeout if FPM is used, default is '5s' |
phpfpm_pass_authorizationheader | bool | whether to pass authorization header to webserver if FPM is used, default is 0 (false) |
override_fpmconfig | bool | whether to override fpm-daemon-config value for the following settings if FPM is used, default is 0 (false) |
pm | string | process-manager to use if FPM is used (allowed values are 'static', 'dynamic' and 'ondemand'), default is fpm-daemon-value |
max_children | int | number of max children if FPM is used, default is the fpm-daemon-value |
start_server | int | number of servers to start if FPM is used, default is fpm-daemon-value |
min_spare_servers | int | number of minimum spare servers if FPM is used, default is fpm-daemon-value |
max_spare_servers | int | number of maximum spare servers if FPM is used, default is fpm-daemon-value |
max_requests | int | number of maximum requests if FPM is used, default is fpm-daemon-value |
idle_timeout | int | number of seconds for idle-timeout if FPM is used, default is fpm-daemon-value |
limit_extensions | string | limitation of php-file-extensions if FPM is used, default is fpm-daemon-value |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | php-settings-id |
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | php-settings-id |
Access: admin
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
with_subdomains | bool | also include subdomains to the list domains that use the config, default 0 (false) |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | |
description | string | description of the php-config |
phpsettings | string | the actual ini-settings |
binary | string | the binary to php-cgi if FCGID is used |
file_extensions | string | allowed php-file-extensions if FCGID is used, default is 'php' |
mod_fcgid_starter | int | number of fcgid-starters if FCGID is used, default is -1 |
mod_fcgid_maxrequests | int | number of fcgid-maxrequests if FCGID is used, default is -1 |
mod_fcgid_umask | string | umask if FCGID is used, default is '022' |
fpmconfig | int | id of the fpm-daemon-config if FPM is used |
phpfpm_enable_slowlog | bool | whether to write a slowlog or not if FPM is used, default is 0 (false) |
phpfpm_reqtermtimeout | string | request terminate timeout if FPM is used, default is '60s' |
phpfpm_reqslowtimeout | string | request slowlog timeout if FPM is used, default is '5s' |
phpfpm_pass_authorizationheader | bool | whether to pass authorization header to webserver if FPM is used, default is 0 (false) |
override_fpmconfig | bool | whether to override fpm-daemon-config value for the following settings if FPM is used, default is 0 (false) |
pm | string | process-manager to use if FPM is used (allowed values are 'static', 'dynamic' and 'ondemand'), default is fpm-daemon-value |
max_children | int | number of max children if FPM is used, default is the fpm-daemon-value |
start_server | int | number of servers to start if FPM is used, default is fpm-daemon-value |
min_spare_servers | int | number of minimum spare servers if FPM is used, default is fpm-daemon-value |
max_spare_servers | int | number of maximum spare servers if FPM is used, default is fpm-daemon-value |
max_requests | int | number of maximum requests if FPM is used, default is fpm-daemon-value |
idle_timeout | int | number of seconds for idle-timeout if FPM is used, default is fpm-daemon-value |
limit_extensions | string | limitation of php-file-extensions if FPM is used, default is fpm-daemon-value |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
subdomain | string | part before domain.tld to create as subdomain |
domain | string | domainname of main-domain |
alias | int | domain-id of a domain that the new domain should be an alias of |
path | string | destination path relative to the customers-homedir, default is customers-homedir |
url | string | overwrites path value with an URL to generate a redirect, alternatively use the path parameter also for URLs |
openbasedir_path | int | either 0 for domains-docroot or 1 for customers-homedir |
phpsettingid | int | php-settings-id, if empty the $domain value is used |
redirectcode | int | redirect-code-id from TABLE_PANEL_REDIRECTCODES |
sslenabled | bool | whether or not SSL is enabled for this domain, regardless of the assigned ssl-ips, default 1 (true) |
ssl_redirect | bool | whether to generate a https-redirect or not, default false; requires SSL to be enabled |
letsencrypt | bool | whether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled |
http2 | bool | whether to enable http/2 for this subdomain (requires to be enabled in the settings), default 0 (false) |
hsts_maxage | int | max-age value for HSTS header, default 0 |
hsts_sub | bool | whether or not to add subdomains to the HSTS header, default 0 |
hsts_preload | bool | whether or not to preload HSTS header value, default 0 |
customerid | int | required when called as admin, not needed when called as customer |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
customerid | int | required when called as admin, not needed when called as customer |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select (sub)domains of a specific customer by id |
loginname | string | admin-only, select (sub)domains of a specific customer by loginname |
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
customerid | int | admin-only, select (sub)domains of a specific customer by id |
loginname | string | admin-only, select (sub)domains of a specific customer by loginname |
Access: admin, customer
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
id | int | the domain-id |
domainname | string | the domainname |
alias | int | domain-id of a domain that the new domain should be an alias of |
path | string | destination path relative to the customers-homedir, default is customers-homedir |
url | string | overwrites path value with an URL to generate a redirect, alternatively use the path parameter also for URLs |
selectserveralias | int | 0 = wildcard, 1 = www-alias, 2 = none |
isemaildomain | bool | |
openbasedir_path | int | either 0 for domains-docroot or 1 for customers-homedir |
phpsettingid | int | php-settings-id, if empty the $domain value is used |
redirectcode | int | redirect-code-id from TABLE_PANEL_REDIRECTCODES |
sslenabled | bool | whether or not SSL is enabled for this domain, regardless of the assigned ssl-ips, default 1 (true) |
ssl_redirect | bool | whether to generate a https-redirect or not, default false; requires SSL to be enabled |
letsencrypt | bool | whether to generate a Let's Encrypt certificate for this domain, default false; requires SSL to be enabled |
http2 | bool | whether to enable http/2 for this domain (requires to be enabled in the settings), default 0 (false) |
hsts_maxage | int | max-age value for HSTS header |
hsts_sub | bool | whether or not to add subdomains to the HSTS header |
hsts_preload | bool | whether or not to preload HSTS header value |
customerid | int | required when called as admin, not needed when called as customer |
Returns no-return-type
Access: admin
Returns string json-encoded array
Parameter
Field | Type | Description |
---|---|---|
min_to_keep | int | minutes to keep, default is 10 |
Returns no-return-type
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
sql_search | array | array with index = fieldname, and value = array with 'op' => operator (one of <, > or =), LIKE is used if left empty and 'value' => searchvalue |
sql_limit | int | specify number of results to be returned |
sql_offset | int | specify offset for resultset |
sql_orderby | array | array with index = fieldname and value = ASC|DESC to order the resultset by one or more fields |
Access: admin
Returns string json-encoded array
Returns no-return-type
Returns no-return-type
Returns no-return-type
Returns no-return-type
Access: admin, customer
Returns string json-encoded array count|list
Parameter
Field | Type | Description |
---|---|---|
year | int | default empty |
month | int | default empty |
day | int | default empty |
customer_traffic | bool | admin-only, whether to output ones own traffic or all of ones customers, default is 0 (false) |
customerid | int | admin-only, select traffic of a specific customer by id |
loginname | string | admin-only, select traffic of a specific customer by loginname |
Returns no-return-type
Returns no-return-type