Set Proxy
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.
Request
URLURL
https://{api_host}/rest/appliance/networking/proxy/{protocol}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The protocol for which proxy should be set. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains NetworkingProxySetRequestBody
of type application/json
(required)
{
"config": {
"enabled": false,
"port": 0,
"server": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | config | NetworkingProxyConfig |
Proxy configuration for the specific protocol. |
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config":{"enabled":false,"password":"string","port":0,"server":"string","username":"string"}}' https://{api_host}/rest/appliance/networking/proxy/{protocol}
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error. |
