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

string
id
Required

Proxy Configuration ID URN

Request Body

The updated proxy configuration API model.

ProxyConfiguration of type(s) application/json
Required 
{
    "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

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

username to connect to the proxy server.

string
password
Required

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

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

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

username to connect to the proxy server.

string
password
Required

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

hostname of the proxy server.

integer
port
Required

port of the proxy server.


Availability
Added in 34.0
On This Page
Proxy Configuration Operations
POST
Create Proxy Configuration
DELETE
Delete Proxy Configuration
GET
Get Proxy Configuration
GET
Query Proxy Configurations
PUT
Update Proxy Configuration