Cancel Item Download Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Cancels 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}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if no download session with the given identifier exists. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the download session is not in the ACTIVE state. |
| default | ErrorRest | Not available |
