Get Environment By Id Or Name V2 Using GET

Get Environment By Id Or Name V2 Using GET

Get an Environment by ID or Name

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

environmentId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EnvironmentDTO of type(s) application/json 
{
    "dataCenterName": "datacenter1",
    "dataCenterVmid": "ee6ce426-ca13-4e56-ad9e-c34a4d3d90c2",
    "environmentData": "string",
    "environmentDescription": "globalenvironment",
    "environmentId": "3893440f-2442-442d-81a2-f4cb9fa9d08f",
    "environmentName": "globalenvironment",
    "state": "string",
    "status": "COMPLETED",
    "transactionId": "string",
    "vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}
string
dataCenterName
Optional

Data Center Name

string
dataCenterVmid
Optional

Data Center ID

string
environmentData
Optional

Environment Data

string
environmentDescription
Optional

Environment Description

string
environmentId
Optional

Environment ID

string
environmentName
Optional

Environment Name

string
state
Optional

State

string
status
Optional

Status

string
transactionId
Optional

transactionId

string
vmid
Optional

vmid


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


On This Page
Environment Controller Operations
POST
Add Node V2 Using POST
POST
Add Product V2 Using POST
POST
Change Ntp Config Pre Validations Using POST
POST
Change Ntp Config Using POST
POST
Collector Group Operation Using POST
POST
Create Cloud Environment Using POST
POST
Create Environment V2 Using POST
DELETE
Delete Environment V2 Using DELETE
GET
Download Environment Logs V2 Using GET
POST
Generate Environment Logs V2 Using POST
GET
Get All Environments V2 Using GET
GET
Get Environment By Id Or Name V2 Using GET
POST
Toggle Ceip Setting Using POST
POST
Toggle Fips Mode Using POST
POST
Toggle Health Check V2 Using POST
POST
Toggle Vcf Environment Using POST
POST
Trigger Health Check V2 Using POST
POST
Trigger Inventory Sync For All Environments V2 Using POST
POST
Trigger Inventory Sync For Environment V2 Using POST
PATCH
Update Environment Name Using PATCH
POST
Validate Environment V2 Using POST
POST
Validate Refresh Token Using POST
POST
V ROP Sadapter Operation V2 Using POST