This API has a deprecated equivalent from v7.0U1.
Cancel Import History
Cancels the task for importing vCenter historical data.
Request
URLURL
https://{api_host}/api/vcenter/deployment/history?action=cancel
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.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases: - If historical data import has not been started yet because a not running task cannot be canceled - If historical data import has already been completed because a completed task cannot be canceled | com.vmware.vapi.std.errors.already_in_desired_state : if vCenter historical data import task is already canceled.
403
com.vmware.vapi.std.errors.unauthorized : if the caller is not authorized to perform 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
Invoke-CancelDeploymentHistory
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/deployment/history?action=cancel
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/vcenter/deployment/history?action=cancel
x-vmw-doc-operation: cancel
Availability
Added in 7.0U2
On This Page
Import History Operations
post
post
