Developer Documentation

SchedulesCreateSpec

The Schedules.CreateSpec structure contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag.


Properties

Required Property Name Type Description
optional backup_password string

Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). If unset the backup piece will not be encrypted.

optional enable boolean

Enable or disable a schedule. If unset the schedule will be enabled.

required location string

URL of the backup location.

optional location_password string

Password for the given location. If unset authentication will not be used for the specified location.

optional location_user string

Username for the given location. If unset authentication will not be used for the specified location.

optional parts array of string

List of optional parts to be backed up. Use the Parts.list operation to get information about the supported parts. If unset all the optional parts will not be backed up.

optional recurrence_info SchedulesRecurrenceInfo

Recurrence information for the schedule. If unset backup job will not be scheduled. See Schedules.RecurrenceInfo

optional retention_info SchedulesRetentionInfo

Retention information for the schedule. If unset all the completed backup jobs will be retained forever. See Schedules.RetentionInfo

Feedback

Was this page helpful?