REST API - get

esx settings depots online: get

Gets the information about a currently configured online software depot.


HTTP request

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

Path Parameters

Name Type Description
depot string Identifier for the depot.


HTTP Status Code: 200

Response Body Structure:





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.


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.