[{"label":"Latest (v1.1)","version":"latest"}]
vmc

Delete SDDCs

Description

Delete SDDC

Request

Request

URL

URL


delete
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}
Copy

Path Parameters

Path Parameters

string
org Required

Organization identifier


string
sddc Required

Sddc identifier


Query Parameters

Query Parameters

boolean
force Optional

If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted.


boolean
retain_configuration Optional

If = ’true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state.


string
template_name Optional

Only applicable when retainConfiguration is also set to ’true’. When set, this value will be used as the name of the SDDC configuration template generated.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type(s) application/json
This response body class contains all of the following: AbstractEntity, InlineTask1
Errors

Errors

ErrorResponse
400

The sddc is not in a state that’s valid for deletion


401

Unauthorized


ErrorResponse
403

Access not allowed to the operation for the current user


ErrorResponse
404

Cannot find the SDDC with given identifier

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-OrgsOrgSddcsSddcDelete -Org "MyOrg" -Sddc "MySddc" -RetainConfiguration $true -TemplateName "MyTemplateName" -Force $true

cURL Command

curl -X DELETE https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: sddcs
x-vmw-vapi-methodname: delete


Feedback

Was this page helpful?