Get Depots Online
Released in v7.0.0 DescriptionGets the information about a currently configured online software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online/{depot}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier for the depot. 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 |
Response
Response
Response BodyResponse Body
200 OK returns
SettingsDepotsOnlineInfo
of type application/json
Information of the currently configured online software depot.
{
"description": "string",
"enabled": false,
"location": "string",
"system_defined": false
}| Property Name | Type | Description |
|---|---|---|
| description | string |
Description of the Depot. It will be an empty string if no description was provided during create. |
| enabled | boolean |
Flag indicating whether this depot is enabled or not. |
| location | string |
Location of the Depot. |
| system_defined | boolean |
Flag to indicate if the depot is system defined. System defined depot can not be deleted. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/online/{depot}
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
| 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 with given identifier 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. |
Depots Online Operations
post
delete
patch
