REST API - set
  1. Operations
  2. esx
  3. settings
  4. depots
  5. umds

esx settings depots umds: set

Sets or overwrites information about an UMDS software depot.

Request:

HTTP request

PUT https://{server}/api/esx/settings/depots/umds
{
    "description" : "string",
    "location" : "http://myurl.com",
    "enabled" : true
}

Body Parameters:

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

Optional. If unset, the description will be empty.
-.enabled boolean Flag indicating whether or not this depot should be enabled. 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.
-.location URI Location of the Depot. It should be the location to the index.xml for that depot.

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 an invalid location is provided.
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.