Socks Proxy API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
enabled |
Whether Socks Proxy is enabled. |
Boolean. Allowable values are True or False. |
|
hostname |
The IP Address or the hostname of the Socks5 server. |
String. This is a mandatory parameter and should be a valid FQDN/IP Address. |
|
port |
The port used by the Socks5 server. |
Integer. This is a mandatory parameter and should be a valid 16 bit unix port. |
|
username |
Username to connect to the Socks5 server. |
String. |
|
password |
Password to connect to the Socks5 server. |
String. If username is specified, it is mandatory to specify the password. |