Update Proxy Configuration

Update Proxy Configuration

Update a specific proxy configuration.

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

Proxy Configuration ID URN


Request Body

The updated proxy configuration API model.

ProxyConfiguration of type(s) application/json
Required

Show optional properties

{
    "name": "Proxy Sample Name",
    "authType": "string",
    "password": "string",
    "host": "sampleProxy.vmware.com",
    "port": 0
}
{
    "name": "Proxy Sample Name",
    "id": "string",
    "description": "Configuration to connect to VC-1",
    "authType": "string",
    "username": "string",
    "password": "string",
    "token": "string",
    "host": "sampleProxy.vmware.com",
    "port": 0
}
string As .*[\S].*
name
Required
Constraints: maxLength: 128

name

string
id
Optional

id

string
description
Optional

Optional description.

string
authType
Required

the type of authentication. 'NO_AUTH' is for an unauthenticated proxy, 'BASIC' is for basic authentication.

string
username
Optional
Constraints: maxLength: 32

username to connect to the proxy server.

string
password
Required
Constraints: maxLength: 128

password to connect to the proxy server, when auth type is Basic.

string
token
Optional

authentication token to connect to the proxy server, when auth type is Bearer.

string
host
Required
Constraints: maxLength: 1004

hostname of the proxy server.

integer
port
Required

port of the proxy server.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProxyConfiguration of type(s) application/json;version=39.1
"ProxyConfiguration Object"
string As .*[\S].*
name
Required
Constraints: maxLength: 128

name

string
id
Optional

id

string
description
Optional

Optional description.

string
authType
Required

the type of authentication. 'NO_AUTH' is for an unauthenticated proxy, 'BASIC' is for basic authentication.

string
username
Optional
Constraints: maxLength: 32

username to connect to the proxy server.

string
password
Required
Constraints: maxLength: 128

password to connect to the proxy server, when auth type is Basic.

string
token
Optional

authentication token to connect to the proxy server, when auth type is Bearer.

string
host
Required
Constraints: maxLength: 1004

hostname of the proxy server.

integer
port
Required

port of the proxy server.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"authType:"string","host:"string","name:"string","password:"string","port:"integer"}' https://{api_host}/cloudapi/1.0.0/proxyConfigurations/{id}