Update Backup Schedules
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Updates a schedule
Request
URLURL
https://{api_host}/rest/appliance/recovery/backup/schedules/update/{schedule}
Parameters
Parameters
string
schedule
Required
Identifier of the schedule
The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
RecoveryBackupSchedulesUpdateRequestBody of type application/json (required){
"spec": {
"backup_password": "string",
"enable": false,
"location": "string",
"location_password": "string",
"location_user": "string",
"parts": [
"string"
],
"recurrence_info": {
"days": "enum",
"hour": 0,
"minute": 0
},
"retention_info": {
"max_count": 0
}
}
}cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"backup_password":"string","enable":false,"location":"string","location_password":"string","location_user":"string","parts":["string"],"recurrence_info":{"days":"enum","hour":0,"minute":0},"retention_info":{"max_count":0}}}' https://{api_host}/rest/appliance/recovery/backup/schedules/update/{schedule}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if provided with invalid schedule specification.
404
com.vmware.vapi.std.errors.not_found : if schedule associated with id does not exist. | com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
On This Page
Backup Schedules Operations
delete
post
