Create ObjectStore Plan

Select

SaaS

Customer Managed

Create a ObjectStore Plan

application/json

Request Body

planName string required
Name of the new plan
backupDestinations object[] required
Copy destinations for the plan. Specify where you want to store your data.
backupDestinationName string required
Backup destination name
storagePool object
id int32
name string
storageType StorageType required
Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]
retentionPeriodDays int32 required
Possible values: >= 1 and <= 9999
Retention period in days. -1 can be specified for infinite retention.
useExtendedRetentionRules boolean
Use extended retention rules
extendedRetentionRules object
If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.
firstExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type string
Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]
All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
secondExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type string
Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]
All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
thirdExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type string
Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]
All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
rpo object
Recovery Point Objective (RPO) is the maximum amount of time that data can be lost during a service disruption. Your RPO determines the frequency of your backup jobs.
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
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.
operationType string
Possible values: [ADD, MODIFY, DELETE, NONE, OVERWRITE]
Operation type for the list
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

Responses

Success

application/json

Schema
Example (from schema)

Schema

plan object
id int32
GUID string
name string
errors object[]
component string
Plan Entity for which error occured
errorCode int32
Error Code for plan
errorMessage string
Error message for plan

{
  "plan": {
    "id": 0,
    "GUID": "string",
    "name": "string"
  },
  "errors": [
    {
      "component": "string",
      "errorCode": 0,
      "errorMessage": "string"
    }
  ]
}

Create ObjectStore Plan​

Create ObjectStore Plan