REST API - keep_alive

content library item update session: keep alive

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.

Request:

HTTP request

POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=keep-alive

Path Parameters

Name Type Description
Required
update_session_id string Identifier of the update session whose lifetime should be extended.

Request Body Structure:

{
    "client_progress"1
}

Request Body Parameters:

Name Type Description
bold = required
client_progress long 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.update_session_model.client_progress.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
404 not_found if no update session with the given identifier exists.
400 not_allowed_in_current_state if the update session is not in the ACTIVE state.