Get Proxy
Retrieves a specific proxy.
Proxy ID URN
Proxy ID URN
OK
{
"name": "Proxy Sample Name",
"id": "string",
"parent": {
"name": "string",
"id": "string"
},
"proxyType": "string",
"enabled": false,
"tenantVisible": false,
"active": false,
"token": "string",
"parentProxy": {
"name": "string",
"id": "string"
},
"targetHost": "sampleVc.vmware.com",
"uiUrl": "https://sampleVc.vmware.com"
}name
id
proxyType
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.
Whether this proxy has been published to tenants.
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.
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.
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.
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.