REST API - create

esx settings depots online: create

Adds a new online software depot to the list of currently configured online software depots.


HTTP request

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

Body Parameters:

Name Type Description
bold = required
- create_spec Depot information.
-.description string Description of the Depot.

Optional. If unset, the description will be empty.

-.location URI Location of the Depot. It should be the location to the index.xml for that depot.

-.enabled boolean Flag indicating whether this depot is enabled or not. Disabling the depot doesn't delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced.

Optional. If unset the depot will be enabled.


HTTP Status Code: 201

Response Body Structure:





Name Type Description
bold = required
- string Identifier of the currently configured online software depot.


HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
400 invalid_argument If an invalid location is provided.
400 already_exists if depot with given location already exists.
500 error If there is some unknown internal error. The accompanying error message will give more details about the failure.
503 service_unavailable If the service is not available.