Delete Environment V2 Using DELETE

Delete Environment V2 Using DELETE

Delete an environment

Request
URI
DELETE
https://{api_host}//10.155.180.238/lcm/lcops/api/v2/environments/{environmentId}
COPY
Path Parameters
string
environmentId
Required

environmentId


Request Body

deleteEnvironmentRequestDTO

DeleteEnvironmentRequestDTO of type(s) application/json
Required
{
    "controllerType": "string",
    "deleteFromInventory": false,
    "deleteFromVcenter": false,
    "deleteLbFromSddc": false,
    "deleteWindowsVMs": false
}
string
controllerType
Optional

controllerType

boolean
deleteFromInventory
Optional

deleteFromInventory

boolean
deleteFromVcenter
Optional

deleteFromVcenter

boolean
deleteLbFromSddc
Optional

deleteLbFromSddc

boolean
deleteWindowsVMs
Optional

deleteWindowsVMs

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GenericRequestResponse of type(s) application/json
{
    "requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}
string
requestId
Optional

Request ID


204

No Content

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations