Find Registered Tenant Environment By Id

Find Registered Tenant Environment By Id

Use this endpoint to get registered agent environment by Id
Authorized Roles : PROVIDER or ORG_ADMIN

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

Id of the Registered Agent Environment

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RegisteredTenantEnvironmentDTO of type(s) application/vnd.vmware.dms-v1+json 
{
    "id": "string",
    "tenantIpAddress": "string",
    "agentVMName": "string",
    "status": "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
id
Optional

id

string
tenantIpAddress
Optional

tenantIpAddress

string
agentVMName
Optional

agentVMName

string
status
Optional

status

Possible values are : REGISTERED, ONBOARDING_IN_PROGRESS, ONBOARDING_SUCCESS, ONBOARDING_FAILED,
array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

On This Page
Agent Environment Registry Operations
DELETE
Delete Registered Tenant Environment By Id
GET
Find Registered Tenant Environment By Id
GET
List Registered Tenant Environments