ATTENTION

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

PhpSettings

PhpSettings.listing

lists all php-setting entries

Permission

admin

Parameter

FieldTypeDescription
with_subdomainsbooloptional, also include subdomains to the list domains that use the config, default 0 (false)
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

PhpSettings.get

return a php-setting entry by id

Permission

admin

Parameter

FieldTypeDescription
idintphp-settings-id

Response

string as json-encoded array

PhpSettings.listingCount

returns the total number of accessible php-setting entries

Permission

admin

Response

string as json-encoded response message

PhpSettings.add

add new php-settings entry

Permission

admin

Parameter

FieldTypeDescription
descriptionstringdescription of the php-config
phpsettingsstringthe actual ini-settings
binarystringoptional the binary to php-cgi if FCGID is used
file_extensionsstringoptional allowed php-file-extensions if FCGID is used, default is 'php'
mod_fcgid_starterintoptional number of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequestsintoptional number of fcgid-maxrequests if FCGID is used, default is -1
mod_fcgid_umaskstringoptional umask if FCGID is used, default is '022'
fpmconfigintoptional id of the fpm-daemon-config if FPM is used
phpfpm_enable_slowlogbooloptional whether to write a slowlog or not if FPM is used, default is 0 (false)
phpfpm_reqtermtimeoutstringoptional request terminate timeout if FPM is used, default is '60s'
phpfpm_reqslowtimeoutstringoptional request slowlog timeout if FPM is used, default is '5s'
phpfpm_pass_authorizationheaderbooloptional whether to pass authorization header to webserver if FPM is used, default is 0 (false)
override_fpmconfigbooloptional whether to override fpm-daemon-config value for the following settings if FPM is used,default is 0 (false)
pmstringoptional process-manager to use if FPM is used (allowed values are 'static', 'dynamic' and'ondemand'), default is fpm-daemon-value
max_childrenintoptional number of max children if FPM is used, default is the fpm-daemon-value
start_serverintoptional number of servers to start if FPM is used, default is fpm-daemon-value
min_spare_serversintoptional number of minimum spare servers if FPM is used, default is fpm-daemon-value
max_spare_serversintoptional number of maximum spare servers if FPM is used, default is fpm-daemon-value
max_requestsintoptional number of maximum requests if FPM is used, default is fpm-daemon-value
idle_timeoutintoptional number of seconds for idle-timeout if FPM is used, default is fpm-daemon-value
limit_extensionsstringoptional limitation of php-file-extensions if FPM is used, default is fpm-daemon-value
allow_all_customersbooloptional add this configuration to the list of every existing customer's allowed-fpm-config list,default is false (no)

Response

string as json-encoded array

PhpSettings.update

update a php-setting entry by given id

Permission

admin

Parameter

FieldTypeDescription
idint
descriptionstringdescription of the php-config
phpsettingsstringthe actual ini-settings
binarystringoptional the binary to php-cgi if FCGID is used
file_extensionsstringoptional allowed php-file-extensions if FCGID is used, default is 'php'
mod_fcgid_starterintoptional number of fcgid-starters if FCGID is used, default is -1
mod_fcgid_maxrequestsintoptional number of fcgid-maxrequests if FCGID is used, default is -1
mod_fcgid_umaskstringoptional umask if FCGID is used, default is '022'
fpmconfigintoptional id of the fpm-daemon-config if FPM is used
phpfpm_enable_slowlogbooloptional whether to write a slowlog or not if FPM is used, default is 0 (false)
phpfpm_reqtermtimeoutstringoptional request terminate timeout if FPM is used, default is '60s'
phpfpm_reqslowtimeoutstringoptional request slowlog timeout if FPM is used, default is '5s'
phpfpm_pass_authorizationheaderbooloptional whether to pass authorization header to webserver if FPM is used, default is 0 (false)
override_fpmconfigbooloptional whether to override fpm-daemon-config value for the following settings if FPM is used,default is 0 (false)
pmstringoptional process-manager to use if FPM is used (allowed values are 'static', 'dynamic' and'ondemand'), default is fpm-daemon-value
max_childrenintoptional number of max children if FPM is used, default is the fpm-daemon-value
start_serverintoptional number of servers to start if FPM is used, default is fpm-daemon-value
min_spare_serversintoptional number of minimum spare servers if FPM is used, default is fpm-daemon-value
max_spare_serversintoptional number of maximum spare servers if FPM is used, default is fpm-daemon-value
max_requestsintoptional number of maximum requests if FPM is used, default is fpm-daemon-value
idle_timeoutintoptional number of seconds for idle-timeout if FPM is used, default is fpm-daemon-value
limit_extensionsstringoptional limitation of php-file-extensions if FPM is used, default is fpm-daemon-value
allow_all_customersbooloptional add this configuration to the list of every existing customer's allowed-fpm-config list,default is false (no)

Response

string as json-encoded array

PhpSettings.delete

delete a php-setting entry by id

Permission

admin

Parameter

FieldTypeDescription
idintphp-settings-id

Response

string as json-encoded array