Run Backup Schedules Deprecated
Initiate backup with the specified schedule
Request
URLURL
https://{api_host}/rest/appliance/recovery/backup/schedules/{schedule}?action=run
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
RecoveryBackupSchedulesRunRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"comment": "string"
}
string
comment
Optional
field that specifies the description for the backup. If unset the backup will have an empty comment.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupSchedulesRunResponseBody of type application/json
BackupJobStatus Structure
{
"value": {
"end_time": "string",
"id": "string",
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"start_time": "string",
"state": "FAILED"
}
}
Errors
400
com.vmware.vapi.std.errors.feature_in_use : if a backup or restore is already in progress.
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
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"comment":"string"}' https://{api_host}/rest/appliance/recovery/backup/schedules/{schedule}?action=run
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/appliance/recovery/backup/schedules/{schedule}?action=run
x-vmw-doc-operation: run
Availability
Added in 6.7
On This Page
Backup Schedules Operations
delete
post
