Get All Environments V2 Using GET
Get all Environments
Request
URI
GET
https://{api_host}//10.155.180.238/lcm/lcops/api/v2/environments
COPY
Query Parameters
string
status
Optional
status
Responses
200
OK
Returns Array of EnvironmentRequestDTO of type(s) application/json
[
{
"environmentDescription": "VMware Aria Automation Automation Environment",
"environmentHealth": "string",
"environmentId": "string",
"environmentName": "VMware Aria Automation Environment",
"environmentStatus": "COMPLETED",
"infrastructure": {
"properties": {
"dataCenterVmid": "d250f635-df41-44b9-b44c-1705c1ed304f",
"regionName": "default",
"zoneName": "default",
"vCenterName": "vCenter-1",
"vCenterHost": "vcenter-1.example.com",
"vcUsername": "administrator@vsphere.local",
"vcPassword": "locker:password:<vmid>:<alias>",
"acceptEULA": "true",
"enableTelemetry": "true",
"adminEmail": "adminuser@vmware.com",
"defaultPassword": "locker:password:<vmid>:<alias>",
"certificate": "locker:certificate:<vmid>:<alias>",
"cluster": "<vc-datacenter>#<cluster>",
"storage": "<storage>",
"folderName": "<folder>",
"resourcePool": "<resource-pool>",
"diskMode": "thin",
"network": "<network>",
"masterVidmEnabled": "false",
"dns": "<dns-server1-ip>,<dns-server2-ip>",
"domain": "<domain>",
"gateway": "<gateway>",
"netmask": "<subnet mask>",
"searchpath": "<search path>",
"timeSyncMode": "<host/ntp>",
"ntp": "<ntp-server1>,<ntp-server2>"
}
},
"logHistory": "string",
"products": [
{
"clusterVIP": {
"clusterVips": [
{
"type": "string"
}
]
},
"collectorGroups": {
"collectorGroups": [
{
"description": "string",
"id": "d7d5624a-f975-48c0-864b-868ca883d979",
"name": "test collector group",
"nodes": [
{
"type": "vrava-primary"
}
]
}
],
"collectorsName": [
"string"
],
"operationType": "add"
},
"id": "vra",
"logHistory": "string",
"nodes": [
{
"type": "vrava-primary"
}
],
"patchHistory": "string",
"snapshotHistory": "string",
"version": "8.3.0"
}
]
}
]
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
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
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
Configure Adapter 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 Environment Requests V2 Using GET
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