Cancel Item Update Session
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
Parameters
Parameters
string
update_session_id
Required
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
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
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
404
com.vmware.vapi.std.errors.not_found : if no update session with the given identifier exists.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.