SOP-005: Shared Proxies Management
Fresh| Field | Value |
|---|---|
| Document ID | SOP-005 |
| Version | 1.0 |
| Status | Active |
| Plan Required | Plus or Business |
Overview
Create, configure, and manage shared proxies that can be distributed to clients or used across multiple applications.
Prerequisites
- Valid API token (SOP-001)
- Proxidize Plus or Business plan
- At least one connected modem
Operations Overview
Operation 1: List All Shared Proxies
Endpoint
GET /api/shared_proxy/Example
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
http://YOUR_SERVER_IP/api/shared_proxy/Response
Returns JSON object with all configured shared proxies.
Operation 2: Create Shared Proxy
Endpoint
GET /api/shared_proxy/add?...parametersRequired Parameters
| Parameter | Description | Values |
|---|---|---|
index | Modem index | Number |
proxy_type | Protocol type | HTTP or SOCKS |
auth_type | Authentication method | UserAuth or IPAuth |
Authentication Parameters
For UserAuth:
| Parameter | Description |
|---|---|
user | Username for authentication |
password | Password for authentication |
For IPAuth:
| Parameter | Description |
|---|---|
IP | Allowed IP addresses (comma-separated) |
Optional Parameters
| Parameter | Description |
|---|---|
comment | Description/notes |
port | Custom port (random if empty) |
bandwidth | Speed limit in Mb/s |
whitelist | Allowed domains (comma-separated) |
blacklist | Blocked domains (comma-separated) |
traffic_limit_amount | Data limit in MB |
traffic_limit_duration | Limit period: day, week, or month |
expire_date | Expiration date (YYYY-MM-DD) |
WARNING
traffic_limit_amount and traffic_limit_duration must BOTH be set to enable traffic limits.
Example: Create UserAuth HTTP Proxy
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
"http://YOUR_SERVER_IP/api/shared_proxy/add?index=1&proxy_type=HTTP&auth_type=UserAuth&user=client1&password=securepass123"Example: Create IPAuth SOCKS Proxy with Limits
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
"http://YOUR_SERVER_IP/api/shared_proxy/add?index=2&proxy_type=SOCKS&auth_type=IPAuth&IP=192.168.1.100,192.168.1.101&bandwidth=50&traffic_limit_amount=10000&traffic_limit_duration=month"Example: Create Proxy with Expiration
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
"http://YOUR_SERVER_IP/api/shared_proxy/add?index=1&proxy_type=HTTP&auth_type=UserAuth&user=temp_user&password=temppass&expire_date=2025-02-01"Operation 3: Delete Specific Shared Proxy
Endpoint
GET /api/shared_proxy/delete?port=PORTExample
bash
# Delete shared proxy on port 35501
curl -H "Authorization: Token YOUR_API_TOKEN" \
"http://YOUR_SERVER_IP/api/shared_proxy/delete?port=35501"Operation 4: Delete All Shared Proxies
Warning
This deletes ALL shared proxies and clears config files. Use with caution!
Endpoint
GET /api/shared_proxy/deleteExample
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
http://YOUR_SERVER_IP/api/shared_proxy/deleteConfiguration Best Practices
Verification Checklist
- [ ] Proxy appears in
/api/shared_proxy/list - [ ] Authentication works with configured credentials
- [ ] Bandwidth limits applied correctly
- [ ] Traffic counting active (if enabled)
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Creation failed | Invalid parameters | Check required fields |
| Auth not working | Wrong auth type | Verify UserAuth vs IPAuth |
| Modem unreachable | Modem offline | Check modem connection |
| Port conflict | Port in use | Let system assign random port |