HTTP API - Socks5 Proxy: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
No edit summary
Line 29: Line 29:
|error_code
|error_code
|Integer
|Integer
|Codes that may be returned: 200: MMS has been sent.
|Codes that may be returned:  
200: MMS has been sent.


400:Bad request. 500: other  errors
400:Bad request.  
 
500: other  errors


503: failed
503: failed

Revision as of 12:15, 9 May 2024

POST http://gateway_ip/api/socks5_proxy

Request Parameters:

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.

Response Parameters:

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.

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}