ATTENTION

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

IpsAndPorts

IpsAndPorts.listing

lists all ip/port entries

Permission

admin

Parameter

FieldTypeDescription
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

IpsAndPorts.listingCount

returns the total number of accessible ip/port entries

Permission

admin

Response

string as json-encoded response message

IpsAndPorts.add

create a new ip/port entry

Permission

admin

Parameter

FieldTypeDescription
ipstring
portintoptional, default 80
listen_statementbooloptional, default 0 (false)
namevirtualhost_statementbooloptional, default 0 (false)
vhostcontainerbooloptional, default 0 (false)
specialsettingsstringoptional, default empty
vhostcontainer_servername_statementbooloptional, default 0 (false)
default_vhostconf_domainstringoptional, defatul empty
docrootstringoptional, default empty (point to froxlor)
sslbooloptional, default 0 (false)
ssl_cert_filestringoptional, requires $ssl = 1, default empty
ssl_key_filestringoptional, requires $ssl = 1, default empty
ssl_ca_filestringoptional, requires $ssl = 1, default empty
ssl_cert_chainfilestringoptional, requires $ssl = 1, default empty
ssl_specialsettingsstringoptional, requires $ssl = 1, default empty
include_specialsettingsbooloptional, requires $ssl = 1, whether or not to include non-ssl specialsettings, default false
ssl_default_vhostconf_domainstringoptional, requires $ssl = 1, defatul empty
include_default_vhostconf_domainbooloptional, requires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false

Response

string as json-encoded array

IpsAndPorts.get

return an ip/port entry by id

Permission

admin

Parameter

FieldTypeDescription
idintip-port-id

Response

string as json-encoded array

IpsAndPorts.update

update ip/port entry by given id

Permission

admin

Parameter

FieldTypeDescription
idint
ipstringoptional
portintoptional, default 80
listen_statementbooloptional, default 0 (false)
namevirtualhost_statementbooloptional, default 0 (false)
vhostcontainerbooloptional, default 0 (false)
specialsettingsstringoptional, default empty
vhostcontainer_servername_statementbooloptional, default 0 (false)
default_vhostconf_domainstringoptional, defatul empty
docrootstringoptional, default empty (point to froxlor)
sslbooloptional, default 0 (false)
ssl_cert_filestringoptional, requires $ssl = 1, default empty
ssl_key_filestringoptional, requires $ssl = 1, default empty
ssl_ca_filestringoptional, requires $ssl = 1, default empty
ssl_cert_chainfilestringoptional, requires $ssl = 1, default empty
ssl_specialsettingsstringoptional, requires $ssl = 1, default empty
include_specialsettingsbooloptional, requires $ssl = 1, whether or not to include non-ssl specialsettings, default false
ssl_default_vhostconf_domainstringoptional, requires $ssl = 1, defatul empty
include_default_vhostconf_domainbooloptional, requires $ssl = 1, whether or not to include non-ssl default_vhostconf_domain, default false

Response

string as json-encoded array

IpsAndPorts.delete

delete an ip/port entry by id

Permission

admin

Parameter

FieldTypeDescription
idintip-port-id

Response

string as json-encoded array