Update Proxy

Update Proxy

Update a specific proxy.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/proxies/{id}
COPY
Path Parameters
string
id
Required

Proxy ID URN

string
id
Required

Proxy ID URN


Request Body

The updated proxy model.

Proxy of type(s) application/json
Required
{
    "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"
}
string As .*[\S].*
name
Required

name

string
id
Optional

id

parent
Required

parent

string
proxyType
Required

proxyType

Possible values are : VC, SSO, NSX, ESX, GENERIC,
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.

boolean
tenantVisible
Optional

Whether this proxy has been published to tenants.

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.

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.

parentProxy
Optional

parentProxy

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 uri 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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Proxy of type(s) application/json;version=38.1
{
    "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"
}
string As .*[\S].*
name
Required

name

string
id
Optional

id

parent
Required

parent

string
proxyType
Required

proxyType

Possible values are : VC, SSO, NSX, ESX, GENERIC,
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.

boolean
tenantVisible
Optional

Whether this proxy has been published to tenants.

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.

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.

parentProxy
Optional

parentProxy

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 uri 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.