Developer Documentation
Update Depots Online
Released in v7.0.0Updates the configuration of a currently configured online software 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 updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online. |
Request Body
Request Body
Contains
OnlineUpdateSpec
of type application/json
(required)
{
"description": "string",
"enabled": false
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | description | string |
Description of the Depot. If unset, description is not updated. |
| optional | enabled | boolean |
Flag indicating whether this depot is enabled or not. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If unset, enabled flag is not updated. |
Errors
| Code | Returns | Description |
|---|---|---|
| 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. |
| 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 parameter 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. |
On This Page
Depots Online Operations
post
patch
delete
