This API has a deprecated equivalent from v7.0U1.
Test Proxy
Tests a proxy configuration by testing the connection to the proxy server and test host.
Request
URLURL
https://{api_host}/api/appliance/networking/proxy/{protocol}?action=test
Path Parameters
Path Parameters
string
protocol
Required
Protocol whose proxy is to be tested.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NetworkingProxyTestRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"config": {
"enabled": false,
"port": 0,
"server": "string"
},
"host": "string"
}
string
host
Required
A hostname, IPv4 or Ipv6 address.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingProxyTestResult
of type application/json
Status of proxy settings.
{
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"status": "SERVER_REACHABLE"
}
status
Required
Proxy.ServerStatus enumerated type defines the status of the server associated with the test run.
SERVER_REACHABLE : Server is reachable.
SERVER_UNREACHABLE : Server is unreachable.
Possible values are: SERVER_REACHABLE , SERVER_UNREACHABLE
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
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}/api/appliance/networking/proxy/{protocol}?action=test
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/networking/proxy/{protocol}?action=test
x-vmw-doc-operation: test
Availability
Added in 7.0U2
