This API has a deprecated equivalent from v7.0U1.
Evict Subscribed Item
DescriptionEvicts the cached content of a library item in a subscribed library. This operation allows the cached content of a library item to be removed to free up storage capacity. This operation will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.cached to false.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.EvictLibraryItem.
Request
URLURL
https://{api_host}/api/content/library/subscribed-item/{library_item_id}?action=evict
Path Parameters
Path Parameters
string
library_item_id
Required
Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
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"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_element_type : if the library item specified by libraryItemId is not a member of a subscribed library. | com.vmware.vapi.std.errors.invalid_element_configuration : if the library item specified by libraryItemId is a member of a subscribed library that does not synchronize on-demand. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it. For instance, this {@term error) is reported on evicting a library item in an on-demand subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.
404
com.vmware.vapi.std.errors.not_found : if the library item specified by libraryItemId does not exist.
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
Invoke-EvictLibraryItemIdSubscribedItem -LibraryItemId "MyLibraryItemId"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/subscribed-item/{library_item_id}?action=evict
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/subscribed-item/id:{library_item_id}?~action=evict
x-vmw-doc-operation: evict
Availability
Added in 7.0U2
On This Page
Subscribed Item Operations
post
