Update Depots Online
Updates 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
string
depot
Required
Identifier of the depot to be updated. 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"
Request Body
Request Body
{
"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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
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 is some unknown internal error. The accompanying error message will give more details about the failure.
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
$SettingsDepotsOnlineUpdateSpec = Initialize-SettingsDepotsOnlineUpdateSpec -Enabled $false -Description "MyDescription"
Invoke-UpdateDepotOnline -Depot "MyDepot" -SettingsDepotsOnlineUpdateSpec $SettingsDepotsOnlineUpdateSpec
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}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
Availability
Added in 7.0.0.0
On This Page
Depots Online Operations
post
patch
delete
delete
