This API has a deprecated equivalent from v7.0U1.
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}/api/content/library/item/download-session/{download_session_id}?action=keep-alive
Path Parameters
Path 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 mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the download session is not in the ACTIVE state.
404
com.vmware.vapi.std.errors.not_found : if no download session with the given identifier exists.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LibraryItemDownloadSessionKeepAliveRequestBody = Initialize-LibraryItemDownloadSessionKeepAliveRequestBody -Progress 0
Invoke-KeepAliveDownloadSessionId -DownloadSessionId "MyDownloadSessionId" -LibraryItemDownloadSessionKeepAliveRequestBody $LibraryItemDownloadSessionKeepAliveRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"progress":0}' https://{api_host}/api/content/library/item/download-session/{download_session_id}?action=keep-alive
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive
x-vmw-doc-operation: keep_alive
Availability
Added in 7.0U2
