Developer Documentation

SchedulesInfo

The Schedules.Info structure contains information about an existing schedule. The structure includes Schedule ID, parts, location information, encryption password, enable flag, recurrence and retention information.


Properties

Required Property Name Type Description
required enable boolean

Enable or disable a schedule, by default when created a schedule will be enabled.

required location string

URL of the backup location.

optional location_user string

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

required parts array of string

List of optional parts that will be included in backups based on this schedule details. Use the Parts.list operation to get information about the supported parts.

optional recurrence_info SchedulesRecurrenceInfo

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

optional retention_info SchedulesRetentionInfo

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

Feedback

Was this page helpful?