REST API - list
  1. Operations
  2. esx
  3. settings
  4. depots
  5. offline

esx settings depots offline: list

Returns currently imported offline software depots.

Request:

HTTP request

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103" : {
        "file_id" : "string",
        "description" : "string",
        "source_type" : "PULL",
        "location" : "http://myurl.com"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Map of currently imported offline software depots keyed by their identifier.Object with element values of type summary.
-.* summary
-.*.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.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
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.