Documentation is now available for the Fall 2020 Update release!

Set external proxy connection

This endpoint is used to configure the external proxy connection on the gateway.

Leave Feedback

URL

POST https://{gatewayIp}:5480/api/v2/externalproxy

Sample URLs

https://192.168.xxx.xxx:5480/api/v2/externalproxy

Sample cURL

curl -k -X POST https://{GatewayIP}:5480/api/v2/externalproxy 
-H 'Accept: application/json' 
-H 'Authorization: Token <TOKEN>' 
-H 'Content-Type: application/json' -k -d ''
{ 
    connection":"<direct/proxy>", 
    "proxy_ip": "<ip>", 
    "proxy_port": "<port>", 
    "proxy_usr": "<username>",
    "proxy_pwd”: "<proxypassword>"
}

Header format

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

The fields are mandatory unless specified as optional.

FieldData TypeDescription
connectionStringType of network connection: direct or proxy
proxy_ipStringProxy IP address for the network.
proxy_portStringPort for the proxy IP address.
proxy_usrString(Optional) Proxy user name.
proxy_pwdString(Optional) Proxy password.

Status code

200 OK

Sample request

{
    "connection": "<direct/proxy>",
    "proxy_ip": "<ip>”, 
    "proxy_port": "<port>", 
    "proxy_usr": "<proxyuser>", 
    "proxy_pwd": "<proxypassword>"
}

Sample response

{"Success":"Successfully updated proxy settings."}