Update Proxy
DescriptionUpdate a specific proxy.
Request
URLURL
Path Parameters
Path Parameters
Proxy ID URN
Request Body
{
"name": "Proxy Sample Name",
"targetHost": "sampleVc.vmware.com"
}
Possible values are: VC , SSO , NSX , ESX , GENERIC
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 EntityReference of the parent entity (e.g. vCenter Server, SDDC) . This is not editable once the proxy has been created.
The EntityReference 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.
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.
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.
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.
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.
Authentication
Response
Response BodyResponse Body
200 OK
{
"name": "Proxy Sample Name",
"targetHost": "sampleVc.vmware.com",
"uiUrl": "https://sampleVc.vmware.com"
}
Possible values are: VC , SSO , NSX , ESX , GENERIC
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 EntityReference of the parent entity (e.g. vCenter Server, SDDC) . This is not editable once the proxy has been created.
The EntityReference 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.
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.
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.
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.
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.
