API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Modems

Reboot one modem when its connection is stuck

Use this when a modem stops passing traffic. AT-command sticks are power-cycled over USB; router-type modems (Hilink, XH20/XH22, CPE) get a reboot command, and when they do not answer the box resets their USB port instead. Needs the IP-rotation license feature.

  • Action · reversible
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • rebootDongle
POST/v2/reboot_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

Reboot 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.
Reboot failed: modem did not answerThe modem ignored the reboot and the USB reset did not work.Try POST /v2/reset_bus_dongle or replug the modem.
Modem disconnected!The modem type cannot be rebooted from the box.Replug the modem.
Verified against XProxy v21.3.2 on Nov 17, 2026