Delete Depots Online
Released in v7.0.0Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online/{depot}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/online/{depot}
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : If there is no depot associated with depot in the system. | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If given depot is system defined. |
On This Page
Depots Online Operations
post
delete
patch
