ATTENTION

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

CustomerBackups

CustomerBackups.add

add a new customer backup job

Permission

admin customer

Parameter

FieldTypeDescription
pathstringpath to store the backup to
backup_dbsbooloptional whether to backup databases, default is 0 (false)
backup_mailbooloptional whether to backup mail-data, default is 0 (false)
backup_webbooloptional whether to backup web-data, default is 0 (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

CustomerBackups.get

You cannot get a planned backup. Try CustomerBackups.listing()

CustomerBackups.update

You cannot update a planned backup. You need to delete it and re-add it.

CustomerBackups.listing

list all planned backup-jobs, if called from an admin, list all planned backup-jobs of all customers you are allowed to view, or specify id or loginname for one specific customer

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select backup-jobs of a specific customer by id
loginnamestringoptional, admin-only, select backup-jobs 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

CustomerBackups.listingCount

returns the total number of planned backups

Permission

admin customer

Parameter

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

Response

string as json-encoded response message

CustomerBackups.delete

delete a planned backup-jobs by id, if called from an admin you need to specify the customerid/loginname

Permission

admin customer

Parameter

FieldTypeDescription
backup_job_entryintid of backup job
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)

Response

bool