[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get SDDC Proxy

Description

Retrieves a specific SDDC proxy.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/sddcProxies/{id}
Copy

Path Parameters

Path Parameters

string
id Required

SDDC Proxy ID URN


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SddcProxy of type(s) application/json;version=36.3
{
    "name": "SDDC Proxy Sample Name",
    "parentProxyId": "urn:vcloud:sddcProxy:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "sddcId": "urn:vcloud:sddc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "targetHost": "sampleVc.vmware.com",
    "uiUrl": "https://sampleVc.vmware.com"
}
string
sddcId Required

URN of the parent SDDC. This is not editable once the proxy has been created.


string
targetHost Required

IP address or FQDN of the host being proxied. Lower case formatting will be applied to the value of the property. This is not editable once the proxy has been created.


string as .*[\S].*
name Required

boolean
enabled Optional

True if the proxy is enabled. Proxy can only be enabled/disabled by privileged users. A disabled proxy cannot be activated and thus, cannot be used. When a proxy is disabled, all active sessions are terminated.


string
id Optional

string
parentProxyId Optional

The URN of the parent proxy. If a proxy has a parent, the proxy is activated along with its parent and shares the token with its parent. Each proxy may only have one parent. A parent proxy cannot have a parent of its own.


boolean
active Optional

True if the proxy is currently active for the user session associated with the request made to get the proxy. An inactive proxy cannot be used.


boolean
defaultProxy Optional

True if this is the default proxy for the parent SDDC. A proxy being the default for the SDDC means that this proxy’s UI will be launched when the SDDC tile is clicked in the H5 Tenant UI of VCD. If no default proxy is set, clicking the SDDC tile will be a no-op.


boolean
tenantVisible Optional

Whether this proxy has been published to tenants.


string
token Optional

The generated read-only token that should be used as the password when using this proxy. To generate a new token, activate the proxy. The token is tied to the user session that activated the proxy. If the proxy is inactive, this value will be null.


string as uri
uiUrl Optional

The URL of the proxied component’s UI endpoint. This is the URL that the browser tab will be pointed to when the proxy is launched via the H5 UI of VCD.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/sddcProxies/{id}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?