Delete Depots Online
DescriptionThe task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot’s content from the system. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online/{depot}
Path Parameters
Path Parameters
string
depot
Required
Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.
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_argument : If the given depot is system-defined. This error is applicable to the task-based Online.delete operation only. | com.vmware.vapi.std.errors.resource_in_use : If the content of depot to be deleted is used in some baseline or desired state. The value of the data field of Error will be the PrecheckResult structure that lists the information of affected baselines and desired states. This error is applicable to the task-based Online.delete operation only.
404
com.vmware.vapi.std.errors.not_found : If there is no depot associated with parameter depot in the system.
500
com.vmware.vapi.std.errors.error : If there some unknown internal error. The accompanying error message will give more details about the failure. For task-based Online.delete operation, once the task is started, it does NOT stop if encountering an error. Instead, it will continuously run to completion. In this case, the value of the data field of Error will be the DeleteResult structure that lists all the errors encountered.
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-DeleteDepotOnline -Depot "MyDepot"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/online/{depot}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 7.0.0.0
On This Page
Depots Online Operations
post
patch
delete
delete
