Apache CloudStack 4.23.0.0 Root Admin API Reference

listBackups

Lists Instance 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 Instancesfalse
statuslist backups by statusfalse
virtualmachineidID of the Instancefalse
zoneidList backups by zone idfalse

Response Tags

Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
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