- API Reference
- Box API
- 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.
/v2/reboot_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
Reboot 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. |
Reboot failed: modem did not answer | The 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. |