Set external proxy connection

Important

An access token must be generated to use this API.

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

Header	Value
Authorization	Token {accessToken}
Content-type	application/json
Accept	application/json

Parameters

The fields are mandatory unless specified as optional.

Field	Data Type	Description
connection	String	Type of network connection: direct or proxy
proxy_ip	String	Proxy IP address for the network.
proxy_port	String	Port for the proxy IP address.
proxy_usr	String	(Optional) Proxy user name.
proxy_pwd	String	(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."}