Get Virtualizor

List 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 List Backup Plans API to list the backup plans present on the Virtualizor panel. The API response will contain a list of information about the backup plans, listed according to their IDs. To filter or limit the size of the list, you can specify one or more query parameters.

See also : Backup Plans guide.

HTTP Request



actGETbackup_plansThe action specified to perform operation and return list of backup plansYes
reslenGETIntNumber of records to be returned, default is 50No
pageGETIntPage number, each page show 50 recordsNo
plannamePOSTtextSearch using the backup plan nameNo

Sample Code



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

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

    $page = 1;
    $reslen = 10;
    $post = array();
    $post['planname'] = '';

    $output = $admin->listbackupplans($page,$reslen,$post);



    "title": "Backup Plans",
    "backup_plans": {
        "1": {
            "bpid": "1",
            "disabled": "0",
            "plan_name": "New backup plan",
            "bid": "0",
            "frequency": "hourly",
            "run_time": "00:00",
            "hourly_freq": "1",
            "run_day": "1",
            "run_date": "1",
            "rotation": "1",
            "backup_limit": "0",
            "restore_limit": "0",
            "enable_enduser_backup_servers": "0",
            "nice": "-20",
            "ionice_prio": "0",
            "ionice_class": "1",
            "disable_compression": "0",
            "dir": "/tmp/ali_backup",
            "backup_server": "Local"
    "timenow": 1536947329,
    "time_taken": "0.140"
    Was this page helpful?
    Newsletter Subscription
    Subscribing you to the mailing list