API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • resetBusDongle
POST/v2/reset_bus_dongle

Request body application/json · required

positionintegerrequired

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.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe license does not include IP rotation.Upgrade the license plan.
modem_not_foundNo modem at this position.Use a position from GET /v2/dongle_device_list.
xle_instance_not_foundThe 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.
Verified against XProxy v21.3.2 on Nov 17, 2026