Content Library Item UpdateSession keepAlive

Keeps an update session alive.

If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of the update session.

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=keep-alive

COPY

Path Parameters

string

updateSessionId

Required

Identifier of the update session whose lifetime should be extended.

The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Request Body

Request body for invoking operation: keepAlive

{
    "client_progress": 0
}

integer As int64 As int64

client_progress

Optional

Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See Content Library Item UpdateSessionModel.client_progress.

If not specified the progress is not updated.

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>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/content/library/item/update-session/{updateSessionId}?action=keep-alive

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Content Operations

GET

Content Library Item UpdateSession list