Edit Backup Plans

Use the Edit Backup Plans API to update the backup plan present on the Virtualizor panel. 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. The API response will contain "done" as "1" on successful update of the backup plan.

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

HTTP Request

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

Parameters

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['bpid'] = 2;
    $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->editbackupplan($post);

    print_r(json_encode($output));
?>

Output

{
    "title": "Edit Backup Plan",
    "done": 1,
    "backup_plan": {
        "bpid": "2",
        "disabled": "0",
        "plan_name": "api backup edit",
        "bid": "0",
        "frequency": "daily",
        "run_time": "02:02",
        "hourly_freq": "1",
        "run_day": "1",
        "run_date": "1",
        "rotation": "1",
        "backup_limit": "0",
        "restore_limit": "0",
        "enable_enduser_backup_servers": "0",
        "nice": "0",
        "ionice_prio": "0",
        "ionice_class": "3",
        "disable_compression": "1",
        "dir": "/tmp/api_backup_edit"
    },
    "timenow": 1536953973,
    "time_taken": "0.141"
}