Apache CloudStack 4.23.0.0 Root Admin API Reference

listBackupProviderOfferings

Lists external backup offerings of the provider

Request parameters

Parameter NameDescriptionRequired
zoneidThe zone IDtrue
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
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
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idID of the backup offering
allowuserdrivenbackupsWhether the offering allows User driven ad-hoc/scheduled backups
backupofferingdetailsDetails for the backup offering
createdThe date this backup offering was created
crosszoneinstancecreationthe backups with this offering can be used to create Instances on all Zones
descriptionDescription for the backup offering
domainthe domain name(s) this backup offering belongs to.
domainidthe domain ID(s) this backup offering belongs to.
externalidExternal ID on the provider side
nameName for the backup offering
providerprovider name
zoneidZone ID
zonenameZone name