Skip to main content

Update Server Plan RPO

API to modify RPO schedules on server plan

Path Parameters
  • planId int32 required

    Id of the Server Plan

Request Body
  • backupFrequency object
  • schedules object[]
  • scheduleId int32

    Id of the schedule if available, required for modifying, deleting schedule

  • scheduleName string

    Name of the schedule, for modify

  • policyId int32

    Schedule policy Id to which the schedule belongs

  • scheduleOperation string

    Possible values: [ADD, DELETE, MODIFY]

    Default value: MODIFY

    Operation being performed on schedule

  • vmOperationType string

    Possible values: [PLANNED_FAILOVER, TEST_BOOT]

    Type of DR operation (only applicable for Failover groups)

  • backupType string required

    Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG]

    Schedule Backup level

  • forDatabasesOnly boolean

    Default value: false

    Boolean to indicate if schedule is for database agents

  • schedulePattern object required

    Used to describe when the schedule runs

  • scheduleFrequencyType string required

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months

  • weeklyDays string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week for weekly frequency

  • dayOfMonth int32

    Possible values: >= 1 and <= 31

    Day on which to run the schedule, applicable for monthly, yearly

  • weekOfMonth string

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    Specific week of a month

  • dayOfWeek string

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

  • monthOfYear string

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

  • repeatIntervalInMinutes int32

    Possible values: >= 1

    How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.

  • repeatUntilTime int32

    Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes

  • timezone object
  • id int32
  • name string
  • startTime int32

    Default value: 75600

    start time of schedule in seconds

  • startDate int32

    start date of schedule in epoch format

  • endDate int32

    Schedule end date in epoch format

  • noOfTimes int32

    The number of times you want the schedule to run.

  • exceptions object[]

    Exceptions to when a schedule should not run, either in dates or week of month and days

  • onDates int32[]

    Possible values: >= 1 and <= 31

    list of dates in a month. For ex: 1, 20

  • onWeekOfTheMonth string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    On which week of month, for ex: FIRST, LAST

  • onDayOfTheWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

    On which days, for ex: MONDAY, FRIDAY

  • daysBetweenSyntheticFulls int32

    Possible values: >= 6

    No of days between two synthetic full jobs

  • maxBackupIntervalInMins int32

    Default value: 240

    The number of mins to force a backup on automatic schedule.

  • scheduleOption object

    Specific options to be set on schedules

  • useDiskCacheForLogBackups boolean

    Used to enable disk caching feature on databases for automatic schedules on server plan

  • commitFrequencyInHours int32

    Commit frequency in hours for disk cache backups from automatic schedules

  • daysBetweenAutoConvert int32

    Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan

  • o365ItemSelectionOption string

    Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]

    item backup option for O365 V2 backup jobs

  • jobRunningTimeInMins int32

    total job running time in minutes

  • operationType string

    Possible values: [ADD, MODIFY, DELETE, NONE, OVERWRITE]

    Operation type for the list

  • backupWindow object[]

    Backup window for incremental backup

  • dayOfWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

  • startTime int64

    Time in seconds since the beginning of the day

  • endTime int64

    Time in seconds since the beginning of the day

  • fullBackupWindow object[]

    Backup window for full backup

  • dayOfWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

  • startTime int64

    Time in seconds since the beginning of the day

  • endTime int64

    Time in seconds since the beginning of the day

  • SLA object

    A server meets SLA (Service Level Agreement) when all of its subclients have at least one successful backup during the number of days specified at the CommCell, Server Group or plan level.

  • useSystemDefaultSLA boolean

    Flag to set to use System Default Service Level Agreement

  • SLAPeriod int32

    SLA Period in Days

  • excludeFromSLA boolean

    Flag to set to exclude plan from SLA

  • enableAfterDelay int32

    Time provided in Unix format. Give 0 to reset any existing delay.

  • exclusionReason string

    Reason for exclusion from SLA

Responses

Success


Schema
  • errorMessage string
  • errorCode int32
Loading...