ATTENTION

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

Mysqls

Mysqls.add

add a new mysql-database

Permission

admin customer

Parameter

FieldTypeDescription
mysql_passwordstringpassword for the created database and database-user
mysql_serverintoptional, default is 0
descriptionstringoptional, description for database
custom_suffixstringoptional, name for database
sendinfomailbooloptional, send created resource-information to customer, default: false
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)

Response

string as json-encoded array

Mysqls.get

return a mysql database entry by either id or dbname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the database-id
dbnamestringoptional, the databasename
mysql_serverintoptional, specify database-server, default is none

Response

string as json-encoded array

Mysqls.update

update a mysql database entry by either id or dbname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the database-id
dbnamestringoptional, the databasename
mysql_serverintoptional, specify database-server, default is none
mysql_passwordstringoptional, update password for the database
descriptionstringoptional, description for database
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)

Response

string as json-encoded array

Mysqls.listing

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

Permission

admin customer

Parameter

FieldTypeDescription
mysql_serverintoptional, specify dbserver to select from, else use all available
customeridintoptional, admin-only, select dbs of a specific customer by id
loginnamestringoptional, admin-only, select dbs of a specific customer by loginname
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

Mysqls.listingCount

returns the total number of accessible databases

Permission

admin customer

Parameter

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

Response

string as json-encoded response message

Mysqls.delete

delete a mysql database by either id or dbname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the database-id
dbnamestringoptional, the databasename
mysql_serverintoptional, specify database-server, default is none
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)

Response

string as json-encoded array