Get By Env ID

Get By Env ID

Endpoint to get environment by id
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER

Request
URI
GET
https://{api_host}/provider/environments/{envID}
COPY
Path Parameters
string
envID
Required

ID of the environment

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TenantEnvironmentDTO of type(s) application/vnd.vmware.dms-v1+json 
{
    "environmentId": "string",
    "tenantId": "string",
    "vcInstanceUuid": "string",
    "vcIpAddress": "string",
    "pscFqdn": "string",
    "vcThumbprint": "string",
    "pscThumbprint": "string",
    "vcDatacenter": {
        "id": "string",
        "moId": "string",
        "name": "string",
        "type": "string",
        "isDefault": false
    },
    "vcVMFolder": {
        "id": "string",
        "moId": "string",
        "name": "string",
        "type": "string",
        "isDefault": false
    },
    "vcCluster": {
        "id": "string",
        "moId": "string",
        "name": "string",
        "type": "string",
        "isDefault": false
    },
    "vcVmDatastores": {
        "list": [
            {
                "mor": "string",
                "datastoreName": "string",
                "isDefault": false
            }
        ]
    },
    "vcAppNetworks": {
        "list": [
            {
                "mor": "string",
                "appNetworkName": "string",
                "isDefault": false
            }
        ]
    },
    "lcpNetwork": {
        "id": "string",
        "moId": "string",
        "name": "string",
        "type": "string",
        "isDefault": false
    },
    "vcSsoUsername": "string",
    "vcSolutionUsername": "string",
    "vcSsoPassword": "string",
    "vcDmsUsername": "string",
    "vcDmsUserPassword": "string",
    "vcDmsROUsername": "string",
    "vcDmsROUserPassword": "string",
    "tenantNtp": "string",
    "tenantIpAddress": "string",
    "providerIpAddress": "string",
    "state": "string",
    "providerRabbitSettings": {
        "rabbitEndpoints": [
            {
                "endpoint": "string",
                "port": 0
            }
        ],
        "username": "string",
        "password": "string"
    },
    "runtimeInfo": [
        {
            "environmentId": "string",
            "alertType": "string",
            "alertStatus": "string",
            "alertTime": "string",
            "environmentName": "string"
        }
    ],
    "status": "string",
    "version": "string",
    "vmRootPassword": "string",
    "clusterType": "string",
    "templateStorage": {
        "id": "string",
        "name": "string",
        "endpoint": "string",
        "bucket": "string",
        "accessKey": "string",
        "secretKey": [
            "string"
        ],
        "region": "string",
        "thumbprint": "string",
        "templateStorage": false
    },
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
environmentId
Optional

environmentId

string As uuid As uuid
tenantId
Required

tenantId

string As uuid As uuid
vcInstanceUuid
Optional

vcInstanceUuid

string
vcIpAddress
Required

vcIpAddress

string
pscFqdn
Optional

pscFqdn

string
vcThumbprint
Optional

vcThumbprint

string
pscThumbprint
Optional

pscThumbprint

object
vcDatacenter
Required

vcDatacenter

object
vcVMFolder
Required

vcVMFolder

object
vcCluster
Required

vcCluster

object
vcVmDatastores
Required

vcVmDatastores

object
vcAppNetworks
Required

vcAppNetworks

object
lcpNetwork
Required

lcpNetwork

string
vcSsoUsername
Optional

vcSsoUsername

string
vcSolutionUsername
Optional

vcSolutionUsername

string
vcSsoPassword
Optional

vcSsoPassword

string
vcDmsUsername
Optional

vcDmsUsername

string
vcDmsUserPassword
Optional

vcDmsUserPassword

string
vcDmsROUsername
Optional

vcDmsROUsername

string
vcDmsROUserPassword
Optional

vcDmsROUserPassword

string
tenantNtp
Optional

tenantNtp

string
tenantIpAddress
Optional

tenantIpAddress

string
providerIpAddress
Required

providerIpAddress

string
state
Optional

state

Possible values are : ACTIVE_MODE, MAINTENANCE_INIT_MODE, MAINTENANCE_ACTIVATED_MODE,
object
providerRabbitSettings
Optional

providerRabbitSettings

array of object
runtimeInfo
Optional

runtimeInfo

string
status
Optional

status

Possible values are : INIT, ONLINE, MAINTENANCE_MODE, DEGRADED, WARNING,
string
version
Optional

version

string
vmRootPassword
Optional

vmRootPassword

string
clusterType
Required

clusterType

Possible values are : VMC, VSPHERE,
object
templateStorage
Required

S3 Storage Details

array of object
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/provider/environments/{envID}
On This Page
Environment Operations
GET
Get Environments
PUT
Update 2
PUT
Update Vc Credentials
PUT
Sync S3 Config
POST
Fetch Infra
POST
Check S3 Connectivity
GET
Get Tenant Env Vm Password
GET
Get Tenant Env Vcenter Password
GET
Get Tenant By Environment
GET
Fetch Networks
GET
Fetch Datastores
GET
Get All Environment Associated Tenants
GET
Get Alerts
GET
Get By Env ID
GET
Search Environment By Tenant Id