- API Reference
- Box API
- Modems
Reset the USB port of a modem that a normal reboot cannot recover
Use this when POST /v2/reboot_dongle does not bring a modem back. Runs a USB reset of the modem's port. For NextGen Android phones it restarts the XProxy app instead; for XLE adapters it resets the adapter's bus. Needs the IP-rotation license feature. msg is empty on success and failure.
/v2/reset_bus_dongleRequest body application/json · required
Slot number (position) on the box, starting at 1. A missing or non-integer value makes the box answer HTTP 500.
Authentication
Needs dashboard Basic credentials when dashboard authentication is enabled; trusted callers (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) pass without them.
Responses
Reset result.
True when the box accepted the request.
Outcome code or message (see the operation's error table).
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
need_upgrade | The license does not include IP rotation. | Upgrade the license plan. |
modem_not_found | No modem at this position. | Use a position from GET /v2/dongle_device_list. |
xle_instance_not_found | The XLE adapter of this slot is not connected. | Check the adapter with GET /get_adapter_list. |
| With status false: the USB reset command failed. | Replug the modem. |