- API Reference
- Box API
- Modems
Start a stopped modem so its proxy works again
Use this to bring a modem back after it was stopped by the user or by Smart IP Guard. Clears the stopped state, logs a resumed event and connects the modem. Always answers status true unless the license lacks IP rotation.
/v2/connect_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
Connect requested, or need_upgrade.
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. |