Content Library Item UpdateSession cancel

Cancels the update session and sets its state to Content Library Item UpdateSessionModel State.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.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Anonymous.

Request

URI

POST

https://{api_host}/api/content/library/item/update-session/{updateSessionId}?action=cancel

COPY

Path Parameters

string

updateSessionId

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.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

if the update session is not in the Content Library Item UpdateSessionModel State.ACTIVE state.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

404

if no update session with the given identifier exists.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/content/library/item/update-session/{updateSessionId}?action=cancel

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Content Operations

GET

Content Library Item UpdateSession list

POST