Apache CloudStack Root Admin API Reference


Lists VM backups

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
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 falsefalse
projectidlist objects by projectfalse
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
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