[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update Proxy Configuration

Description

Update a specific proxy configuration.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/proxyConfigurations/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Proxy Configuration ID URN


Request Body

Request Body

ProxyConfiguration of type(s) application/json Required

The updated proxy configuration API model.

{
    "host": "sampleProxy.vmware.com",
    "name": "Proxy Sample Name"
}
string
authType Required

Possible values are: BASICBEARER


string
host Required

hostname of the proxy server.


string as .*[\S].*
name Required

string
password Required

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


integer
port Required

port of the proxy server.


string
description Optional

Optional description.


string
id Optional

string
token Optional

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


string
username Optional

username to connect to the proxy server.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ProxyConfiguration of type(s) application/json;version=36.3
{
    "description": "Configuration to connect to VC-1",
    "host": "sampleProxy.vmware.com",
    "name": "Proxy Sample Name"
}
string
authType Required

Possible values are: BASICBEARER


string
host Required

hostname of the proxy server.


string as .*[\S].*
name Required

string
password Required

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


integer
port Required

port of the proxy server.


string
description Optional

Optional description.


string
id Optional

string
token Optional

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


string
username Optional

username to connect to the proxy server.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"description":"Configuration to connect to VC-1","host":"sampleProxy.vmware.com","name":"Proxy Sample Name"}' https://{api_host}/cloudapi/1.0.0/proxyConfigurations/{id}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?