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

esx settings depots online: get

Gets the information about a currently configured online software depot.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
depot string Identifier for the depot.

Response:

HTTP Status Code: 200

Response Body Structure:

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

Headers:

None

Type:

Name Type Description
bold = required
- info Information of the currently configured online software depot.
-.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.
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.