ATTENTION

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

MysqlServer

MysqlServer.add

add a new mysql-server

Permission

admin

Parameter

FieldTypeDescription
mysql_hoststringip/hostname of mysql-server
mysql_portstringoptional, port to connect to
mysql_castringoptional, path to certificate file
mysql_verifycertstringoptional, verify server certificate
privileged_userstringprivileged user on the mysql-server (must have GRANT privileges)
privileged_passwordstringpassword of privileged user
descriptionstringoptional, description for server
allow_all_customersbooloptional add this configuration to the list of every existing customer's allowed-mysqlserver-config list, default is false (no)
test_connectionbooloptional, test connection with given credentials, default is true (yes)

Response

string as json-encoded array

MysqlServer.delete

remove a mysql-server

Permission

admin

Parameter

FieldTypeDescription
idintoptional the number of the mysql server (either id or dbserver must be set)
dbserverintoptional the number of the mysql server (either id or dbserver must be set)

Response

string as json-encoded array

MysqlServer.listing

list available mysql-server

Permission

admin customer

Response

string as json-encoded array

MysqlServer.listingCount

returns the total number of mysql servers

Permission

admin customer

Response

string as json-encoded response message

MysqlServer.get

Return info about a specific mysql-server

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional the number of the mysql server (either id or dbserver must be set)
dbserverintoptional the number of the mysql server (either id or dbserver must be set)

Response

string as json-encoded array

MysqlServer.update

update given mysql-server

Permission

admin

Parameter

FieldTypeDescription
idintoptional the number of the mysql server (either id or dbserver must be set)
dbserverintoptional the number of the mysql server (either id or dbserver must be set)
mysql_hoststringip/hostname of mysql-server
mysql_portstringoptional, port to connect to
mysql_castringoptional, path to certificate file
mysql_verifycertstringoptional, verify server certificate
privileged_userstringprivileged user on the mysql-server (must have GRANT privileges)
privileged_passwordstringpassword of privileged user
descriptionstringoptional, description for server
allow_all_customersbooloptional add this configuration to the list of every existing customer's allowed-mysqlserver-config list, default is false (no)
test_connectionbooloptional, test connection with given credentials, default is true (yes)

Response

string as json-encoded array

MysqlServer.databasesOnServer

check whether a given customer / current user (as customer) has databases on the given dbserver

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select ftp-users of a specific customer by id
loginnamestringoptional, admin-only, select ftp-users of a specific customer by loginname

Response

string as json-encoded array count