Delete Sddcs

Delete Sddcs

Delete SDDC

Request
URI
DELETE
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}
COPY
Path Parameters
string
org
Required

Organization identifier.

string
sddc
Required

Sddc Identifier.

Query Parameters
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.

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.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns Task of type(s) application/json
This response body class contains all of the following: AbstractEntity 
{
    "updated": "string",
    "user_id": "string",
    "updated_by_user_id": "string",
    "created": "string",
    "version": 5,
    "updated_by_user_name": "string",
    "user_name": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "status": "string",
    "localized_error_message": "string",
    "resource_id": "string",
    "parent_task_id": "string",
    "task_version": "string",
    "correlation_id": "string",
    "start_resource_entity_version": 0,
    "sub_status": "string",
    "task_type": "string",
    "start_time": "string",
    "task_progress_phases": [
        {
            "id": "string",
            "name": "string",
            "progress_percent": 0
        }
    ],
    "error_message": "string",
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "end_resource_entity_version": 5,
    "service_errors": [
        {
            "default_message": "string",
            "original_service": "string",
            "localized_message": "string",
            "original_service_error_code": "string"
        }
    ],
    "org_type": "string",
    "estimated_remaining_minutes": 4,
    "params": {},
    "progress_percent": 75,
    "phase_in_progress": "string",
    "resource_type": "string",
    "end_time": "string"
}

400

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

Returns ErrorResponse of type(s) application/json 
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


401

Unauthorized

Operation doesn't return any data structure

403

Access not allowed to the operation for the current user

Returns ErrorResponse of type(s) application/json 
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


404

Cannot find the SDDC with given identifier

Returns ErrorResponse of type(s) application/json 
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


On This Page
Sddc Operations
POST
Create Clusters
POST
Create Sddcs
POST
Create Sddcs
DELETE
Delete Clusters
DELETE
Delete Sddcs
GET
Get Provision Spec
GET
Get Sddcs
GET
List Sddcs
PATCH
Patch Sddcs