Cancel Item Update Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Cancels the update session and sets its state to CANCELED. This operation will free up any temporary resources currently associated with the session. This operation is not allowed if the session has been already completed.
Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.
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/update-session/id:{update_session_id}?~action=cancel
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the update session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. |
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/update-session/id:{update_session_id}?~action=cancel
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if no update session with the given identifier exists. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state. |
| default | ErrorRest | Not available |
