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

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

Connect requested, or need_upgrade.

statusbooleanoptional
msgstringoptional

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe license does not include IP rotation.Upgrade the license plan.
Verified against XProxy v21.3.2 on Nov 17, 2026