This API has a deprecated equivalent from v7.0U1.
Create Backup Schedules
DescriptionCreates a schedule
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/schedules
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
RecoveryBackupSchedulesCreateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"schedule": "string",
"spec": {
"location": "string"
}
}
string
schedule
Required
Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if provided with invalid schedule specification. | com.vmware.vapi.std.errors.already_exists : if the schedule with the given id already exists.
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$RecoveryBackupSchedulesCreateSpec = Initialize-RecoveryBackupSchedulesCreateSpec -Location "MyLocation"
$RecoveryBackupSchedulesCreateRequestBody = Initialize-RecoveryBackupSchedulesCreateRequestBody -Schedule "MySchedule" -Spec $RecoveryBackupSchedulesCreateSpec
Invoke-CreateRecoveryBackupSchedules -RecoveryBackupSchedulesCreateRequestBody $RecoveryBackupSchedulesCreateRequestBody
PowerCLI Client SDK All Parameters Example
$RecoveryBackupSchedulesRecurrenceInfo = Initialize-RecoveryBackupSchedulesRecurrenceInfo -Minute 0 -Hour 0 -Days "MONDAY"
$RecoveryBackupSchedulesRetentionInfo = Initialize-RecoveryBackupSchedulesRetentionInfo -MaxCount 0
$RecoveryBackupSchedulesCreateSpec = Initialize-RecoveryBackupSchedulesCreateSpec -Parts "MyParts" -BackupPassword "MyBackupPassword" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -Enable $false -RecurrenceInfo $RecoveryBackupSchedulesRecurrenceInfo -RetentionInfo $RecoveryBackupSchedulesRetentionInfo
$RecoveryBackupSchedulesCreateRequestBody = Initialize-RecoveryBackupSchedulesCreateRequestBody -Schedule "MySchedule" -Spec $RecoveryBackupSchedulesCreateSpec
Invoke-CreateRecoveryBackupSchedules -RecoveryBackupSchedulesCreateRequestBody $RecoveryBackupSchedulesCreateRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"schedule":"string","spec":{"backup_password":"string","enable":false,"location":"string","location_password":"string","location_user":"string","parts":["string"],"recurrence_info":{"days":"MONDAY","hour":0,"minute":0},"retention_info":{"max_count":0}}}' https://{api_host}/api/appliance/recovery/backup/schedules
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/recovery/backup/schedules/{schedule}
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Backup Schedules Operations
delete
patch
post
