Apache CloudStack 4.18.0.0 Root Admin API Reference

listBackups

Lists VM backups

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
id	id of the backup	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
listall	If 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
page		false
pagesize		false
projectid	list objects by project; if projectid=-1 lists All VMs	false
virtualmachineid	id of the VM	false
zoneid	list backups by zone id	false

Response Tags

Response Name	Description
id	ID of the VM backup
account	account name
accountid	account id
backupofferingid	backup offering id
backupofferingname	backup offering name
created	backup date
domain	domain name
domainid	domain id
externalid	external backup id
size	backup size in bytes
status	backup status
type	backup type
virtualmachineid	ID of the VM
virtualmachinename	name of the VM
virtualsize	backup protected (virtual) size in bytes
volumes	backed up volumes
zone	zone name
zoneid	zone id

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.