This API has a deprecated equivalent from v7.0U1.

Delete Item Download Session

Deletes a download session. This removes the session and all information associated with it. Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.

Request

URL

DELETE

https://{api_host}/api/content/library/item/download-session/{download_session_id}

Copy

Path Parameters

string

download_session_id Required

Identifier of the download session to be deleted. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

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.

api_key

Response

204 No Content

Operation doesn't return any data structure.

Errors

Error

404

com.vmware.vapi.std.errors.not_found : if the download session does not exist.

Error

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-DeleteDownloadSessionIdItem -DownloadSessionId "MyDownloadSessionId"

cURL Command

curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/download-session/{download_session_id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/download-session/id:{download_session_id}
x-vmw-doc-operation: delete