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

Get a new public IP for a proxy given its port number

Use this when you only know the port. Same result codes as the other rotation operations. A missing or non-integer port answers HTTP 500.

  • Action · reversible
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • rotateIpByPort
POST/reset_by_port

Request body application/json · required

portintegerrequired

HTTP or SOCKS5 port of the proxy.

Authentication

Always needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.

Responses

Rotation accepted or refused.

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
missing_proxy_parameterproxy is missing.Send proxy=HOST:PORT.
invalid_format_proxyproxy is not HOST:PORT.Send proxy=HOST:PORT.
command_sentWith status true, the rotation started. With status false, the modem did not accept the command.On status false check the slot status before retrying.
modem_resettingA rotation is already running.Wait for MODEM_READY.
reset_too_muchLess than the minimum interval (5 seconds by default) since the last rotation.Wait and retry.
modem_disconnectedThe modem type cannot rotate.Check the modem in the panel.
need_upgradeThe license does not include IP rotation.Upgrade the license.
slot_not_foundNo slot uses this port.Use a port from /api/v1/info_list.
external_server_errorThe external server did not answer.Check that server or add internal=1.
Verified against XProxy v21.3.2 on Nov 17, 2026