3G/4G Proxy

Get proxy IP address

GET proxy_url/api/v1/proxy/public_ip

Examples: localhost:6868/proxy/public_ip?proxy=[proxy ip:port]

Query Parameters

Name	Type	Description
proxy=*	String	proxy with format: [proxy ip:port]

200: OK Internet IP address via proxy

{
    // Response
}

Get list of proxy

GET proxy_url/proxy_list

Change Public IP Address

GET proxy_url/reset

Examples: http://192.168.10.111:6868/reset?proxy=192.168.10.111:4000 OR http://192.168.10.111:6868/reset?proxy=4000

Query Parameters

Name	Type	Description
proxy	String	proxy with format: [proxy ip:port] or port number only

200: OK Ok

{
    // Response
}

Get proxy status

GET proxy_url/status

Query Parameters

Name	Type	Description
proxy	String	proxy with format: [proxy ip:port] or port number only

200: OK {status: true} if dcom is ready

{
    status: true, //true = dcom is ready
    msg = "MODEM_READY" OR "MODEM_BUSY"
}

Get all share proxies

GET proxy_url/api/v1/client/share_proxy/all

200: OK Array of share proxy

[
{
      AllowAccessUrls: string,
      AuthMode: number,
      AutoBindPort: number,
      BlockAccessUrls: number,
      CreationTime: DateTime,
      DestinationPort: number,
      Id: number,
      Password: string,
      Source: string,
      ProxyType: number,
      AllowReset: bool,
      Username: string,
      ProtocolType: number,
      WhitelistIPAddresses: String,
      BandwidthLimit: Number (MB),
      DownloadedCounter: Number (bytes),
      UploadedCounter:  Number (bytes),
      UploadQuota:  Number (MB),
      DownloadQuota: Number (MB),
      ExpiredAt: DateTime,
}
]

Get share proxy details

GET proxy_url/api/v1/client/share_proxy/{id}

200: OK

{
      AllowAccessUrls: string,
      AuthMode: number,
      AutoBindPort: number,
      BlockAccessUrls: number,
      CreationTime: DateTime,
      DestinationPort: number,
      Id: number,
      Password: string,
      Source: string,
      ProxyType: number,
      AllowReset: bool,
      Username: string,
      ProtocolType: number,
      WhitelistIPAddresses: String,
      BandwidthLimit: Number (MB),
      DownloadedCounter: Number (bytes),
      UploadedCounter:  Number (bytes),
      UploadQuota:  Number (MB),
      DownloadQuota: Number (MB),
      ExpiredAt: DateTime,
}

Create share proxy

POST proxy_url/api/v1/client/share_proxy

Headers

Name	Type	Description
Authorization*	String	bearer Code

Request Body

Name	Type	Description
DestinationPort	Number	Port of proxy
AuthMode	Number	None =0, Basic = 1
AllowAccessUrls	String
AutoBindPort	bool
BlockAccessUrls	String
Password	String
Username	String
Source	String
ProtocolType	Number	1 = IPv4, 2 = IPv6
ProxyType	Number	0 = Socks5, 1 = Http
WhitelistIPAddresses	String
AllowReset	bool
DownloadQuota	Number	Value >=0, 0 = Unlimited
UploadQuota	Number	Value >=0, 0 = Unlimited
BandwidthLimit	Number	Value >=0, 0 = Unlimited
ExpiredAt	DateTime

Edit share proxy

PUT proxy_url/api/v1/client/share_proxy/{id}

Headers

Name	Type	Description
Authorization	String	bearer Code

Request Body

Name	Type	Description
DestinationPort*	Number	Port of proxy
AuthMode	Number	None =0, Basic = 1
AllowAccessUrls	String
AutoBindPort	bool
BlockAccessUrls	String
Password	String
Username	String
Source*	String	IP address of dongle
ProtocolType*	Number	1 = IPv4, 2 = IPv6
ProxyType*	Number	0 = Socks5, 1 = Http
WhitelistIPAddresses*	String
AllowReset*	bool
DownloadQuota*	Number	Value >=0, 0 = Unlimited
UploadQuota*	Number	Value >=0, 0 = Unlimited
BandwidthLimit*	Number	Value >=0, 0 = Unlimited
ExpiredAt*	DateTime

Update download and upload quota

PUT proxy_url/api/v1/client/share_proxy/{id}/quota

Headers

Name	Type	Description
Authorization	String	bearer Code

Request Body

Name	Type	Description
DownloadQuota*	Number	Value >= 0
UploadQuota	Number	Value >= 0

Update share proxy expired time

PUT proxy_url/api/v1/client/share_proxy/{id}/expiredAt

Headers

Name	Type	Description
Authorization	String	bearer Code

Request Body

Name	Type	Description
ExpiredAt*	DateTime

Reset download/upload counter all

PUT proxy_url/api/v1/client/share_proxy/resetCounter

Headers

Name	Type	Description
Authorization	String	bearer Code

Reset download/upload counter of a share proxy

PUT proxy_url/api/v1/client/share_proxy/{id}/resetCounter/{id}

Headers

Name	Type	Description
Authorization	String	bearer Code

Delete share proxy

DELETE proxy_url/api/v1/client/share_proxy/{id}

Headers

Name	Type	Description
Authorization	String	bearer Code

Get list of logs

GET proxy_url/api/v1/system/logs

Download a log file

GET proxy_url/api/v1/system/logs/{filename}