Test Proxy
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Tests a proxy configuration by testing the connection to the proxy server and test host.
Request
URLURL
https://{api_host}/rest/appliance/networking/proxy/{protocol}?action=test
Parameters
Parameters
string
protocol
Required
Protocol whose proxy is to be tested.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
NetworkingProxyTestRequestBody of type application/json (required){
"config": {
"enabled": false,
"port": 0,
"server": "string"
},
"host": "string"
}
string
host
Required
A hostname, IPv4 or Ipv6 address.
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingProxyTestResponseBody
of type application/json
Status of proxy settings.
{
"value": {
"status": "enum"
}
}cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config":{"enabled":false,"password":"string","port":0,"server":"string","username":"string"},"host":"string"}' https://{api_host}/rest/appliance/networking/proxy/{protocol}?action=test
