Get Depots Offline
Released in v7.0.0 DescriptionGets the information about an imported offline 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/offline/{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.offline. |
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
SettingsDepotsOfflineInfo
of type application/json
Information about the imported offline software depot.
{
"create_time": "string",
"description": "string",
"file_id": "string",
"location": "string",
"source_type": "enum"
}| Property Name | Type | Description |
|---|---|---|
| create_time | string |
Time when the depot was created. |
| description | string |
Description of the Depot. If not set during import, it will be empty. |
| source_type | SettingsDepotsOfflineSourceType Enum |
Type of the source from which Offline Depot is obtained. |
| file_id | string |
File identifier returned by the file upload endpoint after file is uploaded. This field is optional and it is only relevant when the value of Offline.Info.source-type is PUSH. |
| location | string |
Location of the depot from which content is retrieved. This field is optional and it is only relevant when the value of Offline.Info.source-type is PULL. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/offline/{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 Offline Operations
delete
