Cancel Backup Job Deprecated
Cancel the backup job.
Request
URLURL
https://{api_host}/rest/appliance/recovery/backup/job/{id}/cancel
Path Parameters
Path Parameters
string
id
Required
ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupJobCancelResponseBody of type application/json
BackupJobStatus Structure
{
"value": {
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"status": "FAIL"
}
}
Errors
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" https://{api_host}/rest/appliance/recovery/backup/job/{id}/cancel
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/job/{id}?action=cancel
x-vmw-doc-operation: cancel
