Apache CloudStack 4.23.0.0 Root Admin API Reference

createBackupOffering

Creates a backup offering

Request parameters

Parameter NameDescriptionRequired
allowuserdrivenbackupsWhether users are allowed to create ad-hoc backups and backup schedules when using this offering.true
descriptionThe description of the backup offeringtrue
nameBackup offering name.true
zoneidRestrict the backup offering to the Zone identified by this ID.true
allowextractfileWhether files may be extracted from backups or not.false
allowquickrestoreWhether quick restore is enabled for the backups or not.false
backupchainsizeBackup chain size for backups created with this offering.false
compressWhether the backups should be compressed or not.false
compressionlibraryCompression library, for offerings that support compression. Accepted values are zstd and zlib. By default, zstd is used for images that support it. If the image only supports zlib, it will be used regardless of this parameter.false
domainidRestrict the backup offering to the Domains identified by these IDs.false
validateWhether the backups should be validated or not.false
validationstepsWhich validation steps should be performed. Accepts a comma-separated list of steps. Accepted values are: wait_for_boot, screenshot and execute_command.false

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