- API Reference
- Box API
- Modem reboot
Reboot the modem in one slot
Use this when a slot stays offline and a rotation does not help. Reboots the modem by slot number; a non-answering router-type modem gets a USB reset instead.
/api/v1/reboot/position/{position}Path parameters
Slot number (position) on the box, starting at 1. A value that is not an integer makes the box answer HTTP 500.
1Authentication
Open by default: with "Basic auth for all API" (api_auth_check) off, anyone who can reach the box can call it. When it is on, the caller must be trusted (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or send dashboard Basic credentials, which are checked only when dashboard authentication (dashboard_disable_auth off) is enabled.
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 |
|---|---|---|
modem_not_found | No slot matches the port or position. | Use a port or position from /api/v1/info_list. |
Reboot failed: modem did not answer | The modem ignored the reboot and the USB reset was not possible. | Check the modem and its USB connection on site. |
Modem disconnected! | The modem type cannot be rebooted by the box. | Check the modem in the panel. |
invalid_format_proxy | The proxy value is not HOST:PORT. | Send it as HOST:PORT, for example 192.0.2.10:4001. |