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}/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"
    },
    "vcVMFolder": {
        "id": "string",
        "moId": "string",
        "name": "string"
    },
    "cloudStorage": {
        "endpoint": "string",
        "bucket": "string",
        "region": "string",
        "accessKey": "string",
        "secretKey": "string",
        "thumbprint": "string"
    },
    "localStorage": {
        "endpoint": "string",
        "bucket": "string",
        "region": "string",
        "accessKey": "string",
        "secretKey": "string",
        "thumbprint": "string"
    },
    "vcCluster": {
        "id": "string",
        "moId": "string",
        "name": "string"
    },
    "vcVmDatastores": {
        "list": [
            {
                "mor": "string",
                "datastoreName": "string",
                "default": false
            }
        ]
    },
    "vcNetwork": {
        "id": "string",
        "moId": "string",
        "name": "string"
    },
    "lcpNetwork": {
        "id": "string",
        "moId": "string",
        "name": "string"
    },
    "vcSsoUsername": "string",
    "vcSolutionUsername": "string",
    "vcSsoPassword": "string",
    "tenantNtp": "string",
    "dbFqdnSuffix": "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",
    "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

VcManagedObject
vcDatacenter
Required

vcDatacenter

VcManagedObject
vcVMFolder
Required

vcVMFolder

CloudStorage
cloudStorage
Required

cloudStorage

LocalStorage
localStorage
Required

localStorage

VcManagedObject
vcCluster
Required

vcCluster

VcDatastores
vcVmDatastores
Required

vcVmDatastores

VcManagedObject
vcNetwork
Required

vcNetwork

VcManagedObject
lcpNetwork
Required

lcpNetwork

string
vcSsoUsername
Required

vcSsoUsername

string
vcSolutionUsername
Optional

vcSolutionUsername

string
vcSsoPassword
Required

vcSsoPassword

string
tenantNtp
Optional

tenantNtp

string
dbFqdnSuffix
Required

dbFqdnSuffix

string
tenantIpAddress
Optional

tenantIpAddress

string
providerIpAddress
Required

providerIpAddress

string
state
Optional

state

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

providerRabbitSettings

array of TenantEnvRuntimeInfoDTO
runtimeInfo
Optional

runtimeInfo

string
status
Optional

status

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

version

string
vmRootPassword
Optional

vmRootPassword

array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

On This Page
Environment Operations
PUT
Assign Tenant
GET
Get Alerts
GET
Get All Environment Associated Tenants
GET
Get By Env ID
GET
Get Tenant By Environment
GET
Get Tenant Env Vm Password
GET
Search Environment By Tenant Id
PUT
Unassign Tenant