Apache CloudStack Root Admin API Reference


Creates a user-defined VM backup schedule

Request parameters

Parameter NameDescriptionRequired
intervaltypevalid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
schedulecustom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
virtualmachineidID of the VM for which schedule is to be definedtrue

Response Tags

Response NameDescription
idID of the VM backup
accountaccount name
accountidaccount id
backupofferingidbackup offering id
backupofferingnamebackup offering name
createdbackup date
domaindomain name
domainiddomain id
externalidexternal backup id
sizebackup size in bytes
statusbackup status
typebackup type
virtualmachineidID of the VM
virtualmachinenamename of the VM
virtualsizebackup protected (virtual) size in bytes
volumesbacked up volumes
zonezone name
zoneidzone id