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

esx settings depots online: list

Returns a list of currently configured online software depots.

Request:

HTTP request

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103" : {
        "system_defined" : true,
        "description" : "string",
        "location" : "http://myurl.com",
        "enabled" : true
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Map of currently configured online software depots keyed by their identifiers.Object with element values of type summary.
-.* summary
-.*.description string Description of the Depot. It will be an empty string if no description was provided during create.
-.*.location URI Location of the Depot.
-.*.enabled boolean Flag indicating whether this depot is enabled or not.
-.*.system_defined boolean Flag to indicate if the depot is system defined. System defined depot can not be deleted.

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.