REST API - get

esx settings depots offline: get

Gets the information about an imported offline software depot.

Request:

HTTP request

GET https://{server}/api/esx/settings/depots/offline/{depot}

Path Parameters

Name	Type	Description
Required
depot	string	Identifier for the depot.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "create_time" : "2015-01-01T22:13:05.651Z",
    "file_id" : "string",
    "description" : "string",
    "source_type" : "PULL",
    "location" : "http://myurl.com"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the imported offline software depot.
-.description	string	Description of the Depot. If not set during import, it will be empty.
-.source_type	string	Type of the source from which Offline Depot is obtained. Defines possible values of sources for the offline depot. Value is one of: PULL: Content is pulled from the URL location. The URL scheme of the value in {@link #pullLocation) can be http, https or file. PUSH: Content was previously uploaded using the file upload enpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.
-.location	URI	Location of the depot from which content is retrieved. Optional. It is only relevant when source_type has value [PULL]. This field is optional and it is only relevant when the value of `source_type` is PULL.
-.file_id	string	File identifier returned by the file upload endpoint after file is uploaded. Optional. It is only relevant when source_type has value [PUSH]. This field is optional and it is only relevant when the value of `source_type` is PUSH.
-.create_time	date_time	Time when the depot was created.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the caller is not authenticated.
404	not_found	If there is no depot with given identifier `depot` in the system.
503	service_unavailable	If the service is not available.
500	error	If there is some unknown internal error. The accompanying error message will give more details about the failure.