Keep Alive Item Download Session
Keeps a download session alive. This operation is allowed only if the session is in the ACTIVE state. If there is no activity for a download session for a certain period of time, the download session will expire. The download 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 an active download session.
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/download-session/id:{download_session_id}?~action=keep-alive
Parameters
Parameters
string
download_session_id
Required
Identifier of the download session whose lifetime should be extended.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
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
Request Body
Request Body
LibraryItemDownloadSessionKeepAliveRequestBody of type application/json (required){
"progress": 0
}
integer
progress
Optional
Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See DownloadSessionModel.client-progress. If not specified the progress is not updated.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"progress":0}' https://{api_host}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive
Errors
404
com.vmware.vapi.std.errors.not_found : if no download session with the given identifier exists.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the download 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.
