Esx. Settings. Depots. Umds Delete

Esx. Settings. Depots. Umds Delete

The task-based delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleDepots.Delete.
Request
URI
DELETE
https://{api_host}/esx/settings/depots/umds
COPY
Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

If the content of UMDS depot to be deleted is used in some baseline or desired state. The value of the data property of Vapi.Std.Errors.Error will be the PrecheckResult schema that lists the information of affected baselines and desired states. This error is applicable to the task-based delete operation only.

Returns Vapi.Std.Errors.ResourceInUse of type(s) application/json 
"Vapi.Std.Errors.ResourceInUse Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

If there is no UMDS depot configured in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there some unknown internal error. The accompanying error message will give more details about the failure. For task-based delete operation, once the task is started, it does NOT stop if encountering an error. Instead, it will continuously run to completion. In this case, the value of the data property of Vapi.Std.Errors.Error will be the DeleteResult schema that lists all the errors encountered.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/esx/settings/depots/umds
On This Page
Esx.settings.depots.umds Operations
GET
Esx. Settings. Depots. Umds Get
PUT
Esx. Settings. Depots. Umds Set
DELETE
Esx. Settings. Depots. Umds Delete
PATCH
Esx. Settings. Depots. Umds Update
DELETE
Esx. Settings. Depots. Umds Delete$ Task