List Backup Schedules

Description

Use this call to obtain the list of the available backup schedules. Backup schedules are created by the system administrator. If you would like to perform server backups on a regular basis, you can obtain the list of the available schedules using this call, then choose a schedule that suits your needs and specify its name when configuring your server.

Syntax

GET baseURL/schedule

Request Parameters

None

Response

Element

Attribute

Description

backup-schedule-list

 

Container for backup schedule list.

backup-schedule

 

Container for an individual backup schedule.

 

id

Schedule ID.

Type: int

 

name

Schedule name.

Type: string

 

cron-expression

Standard CRON expression.

Type: string

 

enabled

Specifies whether the backup schedule is enabled. Disabled schedules cannot be assigned to servers.

Type: boolean

 

backups-to-keep

Maximum number of server backups to keep on the backup server.

Type: int

 

no-of-incremental

Number of incremental backups before a full backup is performed.

Type: int

Example

Request

GET https://c2u-web:4465/paci/v1.0/schedule

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<backup-schedule-list>
    <backup-schedule no-of-incremental="6" backups-to-keep="30" enabled="true" cron-expression="0 0 12 * * ?" name="daily" id="1">
        <description>Daily</description>
    </backup-schedule>
    <backup-schedule no-of-incremental="5" backups-to-keep="24" enabled="true" cron-expression="0 0 * * * ?" name="hourly" id="3">
        <description>hourly</description>
    </backup-schedule>
    <backup-schedule no-of-incremental="4" backups-to-keep="25" enabled="true" cron-expression="0 0 6 ? * 7" name="weekly" id="2">
        <description>Weekly</description>
    </backup-schedule>
</backup-schedule-list>