Apache CloudStack v4.6.0 Root Admin API Reference


Creates a snapshot policy for the account.

Request parameters

Parameter NameDescriptionRequired
intervaltypevalid values are HOURLY, DAILY, WEEKLY, and MONTHLYtrue
maxsnapsmaximum number of snapshots to retaintrue
scheduletime the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.true
volumeidthe ID of the disk volumetrue
fordisplayan optional field, whether to the display the policy to the end user or notfalse

Response Tags

Response NameDescription
idthe ID of the snapshot policy
fordisplayis this policy for display to the regular user
intervaltypethe interval type of the snapshot policy
maxsnapsmaximum number of snapshots retained
scheduletime the snapshot is scheduled to be taken.
timezonethe time zone of the snapshot policy
volumeidthe ID of the disk volume