This API has a deprecated equivalent from v7.0U1.
Delete Local Library
DescriptionDeletes the specified local library. Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.
Request
URLURL
https://{api_host}/api/content/local-library/{library_id}
Path Parameters
Path Parameters
string
library_id
Required
Identifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.
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 specified by libraryId is not a local library. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the library contains a library item that cannot be deleted in its current state. For example, the library item contains a virtual machine template and a virtual machine is checked out of the library item.
404
com.vmware.vapi.std.errors.not_found : if the library specified by libraryId 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-DeleteLibraryIdContentLocalLibrary -LibraryId "MyLibraryId"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/local-library/{library_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/com/vmware/content/local-library/id:{library_id}
x-vmw-doc-operation: delete
Availability
Added in 7.0U2
On This Page
Local Library Operations
post
delete
patch
