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}
Parameters
Parameters
string
depot
Required
Identifier for the depot.
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, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
SettingsDepotsOnlineUpdateSpec of type application/json (required){
"description": "string",
"enabled": false
}
string
description
Optional
Description of the Depot. If unset, description is not updated.
boolean
enabled
Optional
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.
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","enabled":false}' https://{api_host}/api/esx/settings/depots/online/{depot}
Errors
404
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
delete
patch
