Create Server Plan RPO Schedules
API to create RPO schedules on server plan
Path Parameters
- planId int32 required
Id of the Plan to modify
- application/json
Request Body
rpo object required
databaseOptions object
Responses
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
rpo object
error object
{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Requested Details not found
POST /v4/serverplan/:planid/rpo
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'
curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/RPO' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rpo": {
"backupFrequency": {
"schedules": [
{
"scheduleId": 0,
"scheduleName": "string",
"policyId": 0,
"scheduleOperation": "MODIFY",
"vmOperationType": "PLANNED_FAILOVER",
"backupType": "FULL",
"forDatabasesOnly": false,
"schedulePattern": {
"scheduleFrequencyType": "MINUTES",
"frequency": 0,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"repeatIntervalInMinutes": 0,
"repeatUntilTime": 0,
"timezone": {
"id": 0,
"name": "string"
},
"startTime": 75600,
"startDate": 0,
"endDate": 0,
"noOfTimes": 0,
"exceptions": [
{
"onDates": [
0
],
"onWeekOfTheMonth": [
"FIRST"
],
"onDayOfTheWeek": [
"SUNDAY"
]
}
],
"daysBetweenSyntheticFulls": 0,
"maxBackupIntervalInMins": 240
},
"scheduleOption": {
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0,
"daysBetweenAutoConvert": 0,
"o365ItemSelectionOption": "SELECT_ALL",
"jobRunningTimeInMins": 0
}
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
]
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
}
}'