Add Backup Plans

Backup plans enable you to create different VPS backup settings for different VPS on the same server(s). You can assign backup plans to individual VPS or to the entire VPS plan. You can also allow the endusers to initiate backup/restore of their VPS at their will in the backup plan. Use the Add Backup Plans API to create a backup plan on the Virtualizor panel. The API response will contain “done” as “1” on successful creation of the backup plan.

For more information, you can refer this Backup Plans guide.

HTTP Request

https://hostname:4085/index.php?act=addbackup_plan

Parameters

NameMethodValueDescriptionRequired
actGETaddbackup_planThe action specified to perform operation and will return “done” as “1” on successful creation of the backup planYes
disabledPOST1/0If set this backup plan will be disabledNo
plan_namePOSTtextThe name of the backup planYes
typePOSTtextThe backup type valid values are ‘LOCAL’, ‘FTP’ and ‘SSH’Yes
idPOSTIntID of the backup server required if backup type is SSH or FTPNo
dirPOSTtextThe path of the directory where backups will be storedYes
freqPOSTtextBackup Frequency valid values are ‘hourly’, ‘daily’, ‘weekly’ and ‘monthly’Yes
hourly_freqPOSTIntThe hourly backup frequency valid values (0-23)Yes
hrsPOSTIntThe hour at which the backup will begin values are (0-23)Yes
minPOSTIntThe minute at which the backup will begin values are (0-59)Yes
dayPOSTIntThe day of the week when the backup will begin valid values are(1 for Monday to 7 for Sunday)Yes
datePOSTIntThe date at which backup will begin valid values are (1-31)Yes
rotationPOSTIntNumber of backup per VPS allowed (0-10), 0 for unlimitedYes
backup_limitPOSTIntMax number of manual backup operations the VPS user can perform per month valid values are (-1 to 10), -1 for unlimited and 0 for disabledYes
restore_limitPOSTIntMax number of restore operations the VPS user can perform per month valid values are (-1 to 10), -1 for unlimited and 0 for disabledYes
nicePOSTIntCPU time the backup process will get. 19 (least favourable) to -20 (most favourable)Yes
ionice_prioPOSTIntIO priority for the backup process valid values are (0-7)Yes
ionice_classPOSTIntIO class for the backup process valid values (1 for Real time, 2 for Best Effort, 3 for Idle )Yes
compressionPOST1/0Disable compression for the backups. This will take effect only for KVM, Xen-HVM and OpenVZNo

Sample Code

<?php

    require_once('/usr/local/virtualizor/sdk/admin.php');

    $key =  'your_api_key';
    $pass = 'your_api_pass';
    $ip = 'your_server_ip';

    $admin = new Virtualizor_Admin_API($ip, $key, $pass);

    $post = array();
    $post['type'] = 'LOCAL' ;
    $post['plan_name'] = 'api backup' ;
    $post['id'] = 1 ;
    $post['dir'] = '/tmp/api_backup/' ;
    $post['freq'] = 'hourly' ;
    $post['hourly_freq'] = 1 ;
    $post['hrs'] = 0 ;
    $post['min'] = 0 ;
    $post['day'] = 1 ;
    $post['date'] = 1 ;
    $post['rotation'] = 1 ;
    $post['backup_limit'] = 0 ;
    $post['restore_limit'] = 0 ;
    $post['nice'] = 0 ;
    $post['ionice_prio'] = 0 ;
    $post['ionice_class'] = 3 ;
    $post['compression'] = 1 ;

    $output = $admin->addbackupplan($post);

    print_r(json_encode($output));
?>

Output

{
    "title": "Add Backup Plan",
    "done": 1,
    "timenow": 1536952659,
    "time_taken": "0.213"
}
Was this helpful to you?