API Docs

Get to know backup_change_schedule

Overview: backup_change_schedule changes the backup schedule for a VM.

backup_change_schedule expects the following parameters:

  • vm_id – The identifier of the VM you want to retrieve the welcome emails from.
  • name | the name of the backup you want to be called when created.
  • schedule | options: hourly, weekly, monthly | the schedule to set for this VM.
  • number_of_backups | The number of backups to retain.

    • daily | options: 1-7
    • weekly | options: 1-5
    • monthly | options: 1-12

Example:

$params = array(
        'vm_id' => 1,
        'schedule' => 'weekly',
        'name' => 'backup weekly 1',
        'number_of_backups' => 3
        );
$api->call('cloud.backup_change_schedule', $params);

Output:

Array
(
    [status] => 1
)