Apache CloudStack 4.21.0.0 Root Admin API Reference

listBackups

Lists VM backups

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
backupofferingidlist backups by backup offeringfalse
domainidlist only resources belonging to the domain specifiedfalse
idid of the backupfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
listvmdetailslist backups with VM detailsfalse
namelist backups by namefalse
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
virtualmachineidid of the VMfalse
zoneidlist backups by zone idfalse

Response Tags

Response NameDescription
idID of the VM backup
accountaccount name
accountidaccount id
backupofferingidbackup offering id
backupofferingnamebackup offering name
createdbackup date
descriptiondescription for the backup
domaindomain name
domainiddomain id
externalidexternal backup id
intervaltypeInterval type of the backup
namename of the backup
sizebackup size in bytes
statusbackup status
typebackup type
virtualmachineidID of the VM
virtualmachinenamename of the VM
virtualsizebackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesbacked up volumes
zonezone name
zoneidzone id