With this function, you can create/manage backup job.
| Parameter name | Type | Description | Possible values | Example |
|---|---|---|---|---|
| _id | String | Required on action modify The backup job id. |
5b5eb6a0d5ac5e23727b4772 | |
| action | String | Required The action you want to perform. |
|
|
| name | String | Required on action create The name of the backup job. |
||
| backuptypes | Integer | Required on action create The content of the backup (Accounts, Directories, Replicate) |
To view the possible values click on Backup Types | |
| destination | String | Required on action create The ID of the destination. |
||
| filters[] | List | The group ids you want to filter with.
if you want one filter or another, insert every id in a different cell.
if you want one filter and another, insert the ids in the same cell.
|
filters[0][0]=5b34b4f8d5ac5e18436008d3& filters[0][1]=5b5ee4efd5ac5e0fe26db823& filters[1][0]=5b6a87abd5ac5e655e2018d3 | |
| flag | Integer | Required on action create The backup structure you want to use. |
|
|
| limitaccounts | Integer | The number of accounts to backup on each cron run. | 0 | |
| maximumruntime | Integer | The maximum run time for each cron run. | 0 | |
| loadpausetime | Integer | The time in seconds the backup job will pause when reaching specified load. | 1 | |
| loadpauserate | Integer | The value of the server load the backup job will pause when reached. | 1 | |
| retrytimes | Integer | Number of times the backup job will retry to transfer data in case sync process fails. | 5 | |
| monitor | Object | The job monitor parameters. | To view the possible values click on Monitor Object | monitor[ranfor]=1&monitor[notran]=1 |
| options | Boolean | The option to Backup only Emails structure. | ||
| performance | Object | The performance override parameters. | To view the possible values click on Performance Object | performance[lve]=0&performance[ionice]=0&performance[renice]=0 |
| excludelist[] | List | Directories and Files to exclude | excludelist[0]=/Path/of/file1&excludelist[1]=/Path/of/file2 | |
| includelist[] | List | Directories and Files to include.
To view the parameters returned, click on List of String.
Dosen't exsist in accounts.
|
includelist[0]=/Path/of/file1&includelist[1]=/Path/of/file2 | |
| schedules[] | List | List of objects(_id, retain). To create new schedule click on manageSchedule To get the schedule id you can get it in the manageSchedule response or click on listSchedules retain - The amount backup to retain before you do retention. |
schedules[0][_id]=5b5eeb87d5ac5e1e3611a4f2& schedules[0][retain]=1 | |
| time | Integer | The scheduled time of the job. if you want to schedule to 12:00 AM the value should be 0000(0), for 12:10 AM the value should be 0010(10), for 3:00 PM the value should be 1500. |
1500 | |
| disabled | Boolean | Whether the backup job is disabled. |