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

esx settings depots online: update

Updates the configuration of a currently configured online software depot.

Request:

HTTP request

PATCH https://{server}/api/esx/settings/depots/online/{depot}
{
    "description" : "string",
    "enabled" : true
}

Path Parameters

Name Type Description
Required
depot string Identifier of the depot to be updated.

Body Parameters:

Name Type Description
bold = required
- update_spec Update specification.
-.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, enabled flag is not updated.
-.description string Description of the Depot.

Optional. If unset, description is not updated.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
400 invalid_argument If given depot is system defined.
404 not_found If there is no depot associated with parameter depot in the system.
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.