HTTP API - Socks5 Proxy

From Ultiroam User Docs
Revision as of 23:05, 2 May 2024 by Administrator (talk | contribs) (Created page with "=== 9.1         Request === '''POST <nowiki>https://gateway_ip/api/socks5_proxy</nowiki>''' 9.2         '''Request Parameter''' {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Interger | |- |state |String |It could be “on” or “off”. Use “on” to enable socks5 proxy on this port. Use “off” to disable socks5 proxy on this port. |} == 9.3         Response Paramet...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

9.1         Request

POST https://gateway_ip/api/socks5_proxy

9.2         Request Parameter

Parameter Type Description
Required Parameter
port Interger
state String It could be “on” or “off”.

Use “on” to enable socks5 proxy on this port. Use “off” to disable socks5 proxy on this port.

9.3         Response Parameter

Parameter Type Description
error_code Integer Codes that may be returned: 200: MMS has been sent.

400:Bad request. 500: other errors

503: failed

sn String SN of the gateway
socks_port Interger socks proxy port for this request.

9.4         Example

Request:

curl -k --anyauth -u admin:admin -d '{"port":0,"state":"on"}' -H  "Content-Type: application/json" https://gateway_ip/api/socks5_proxy

Response:

{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","socks_port":1080}