This API has a deprecated equivalent from v7.0U1.
Cancel Item Download Session
DescriptionCancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Request
URLURL
https://{api_host}/api/content/library/item/download-session/{download_session_id}?action=cancel
Path Parameters
Path Parameters
string
download_session_id
Required
Identifer of the download session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
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 the download session is not in the ACTIVE state.
404
com.vmware.vapi.std.errors.not_found : if no download session with the given identifier exists.
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-CancelDownloadSessionId -DownloadSessionId "MyDownloadSessionId"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/download-session/{download_session_id}?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/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel
x-vmw-doc-operation: cancel
Availability
Added in 7.0U2
