[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Get Environment By ID Or Name V2

Description

Get an Environment by ID or Name

Request

Request

URL

URL


get
https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}
Copy

Path Parameters

Path Parameters

string
environmentId Required

environmentId


Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

Returns EnvironmentDTO of type(s) application/json
{
    "dataCenterName": "datacenter1",
    "dataCenterVmid": "ee6ce426-ca13-4e56-ad9e-c34a4d3d90c2",
    "environmentDescription": "globalenvironment",
    "environmentId": "3893440f-2442-442d-81a2-f4cb9fa9d08f",
    "environmentName": "globalenvironment",
    "status": "COMPLETED",
    "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

string
vmid Optional
Errors

Errors

GenericErrorResponseDTO
400

Bad Request


401

Unauthorized


403

Forbidden


GenericErrorResponseDTO
404

Not Found


GenericErrorResponseDTO
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}


Feedback

Was this page helpful?