Content Library Item DownloadSession cancel

Cancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.

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/download-session/{downloadSessionId}?action=cancel

COPY

Path Parameters

string

downloadSessionId

Required

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.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

if the download session is not in the Content Library Item DownloadSessionModel 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 download 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/download-session/{downloadSessionId}?action=cancel

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Content Operations

GET

Content Library Item DownloadSession list

POST