Toggle Vcf Environment Using POST

Toggle Vcf Environment Using POST

Toggle VCF Environment

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

environmentId


Request Body

toggleVcfEnvironmentDTO

ToggleVcfEnvironmentDTO of type(s) application/json
Required
{
    "productToLbMap": "{\"vrops\": \"vrops-lb.vsphere.local\", \"vra\": \"vra-lb.vsphere.local\"}",
    "turnOffVcfEnabledEnvironment": false
}
string
productToLbMap
Optional

Product to Load Balancer map

boolean
turnOffVcfEnabledEnvironment
Optional

turnOffVcfEnabledEnvironment

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


201

Created

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

Operation doesn't return any data structure

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