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

Change the label number of a modem

Use this to give a modem a fixed label number (used for sorting and per-label settings such as APN). Hilink, ZTE, XProxy (XH20/XH22) and Alcatel modems store it on the device; other modems with a serial number store it in the box database. On success the modem reboots to apply it.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • changeLabel
POST/v2/change_label

Request body application/json · required

positionintegerrequired
labelintegerrequired

New label number.

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

Result.

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
modem_not_foundNo modem at this position.Use a position from GET /v2/dongle_device_list.
An error when changing LabelThe modem rejected the label.Reboot the modem and try again.
Modem is not support for changing Label!The modem has no serial number and no label support.None; this modem type cannot be labelled.
Sent change IMEI failed. Please try again later!position or label missing or not an integer (the box reuses the IMEI text here).Send both as integers.
Verified against XProxy v21.3.2 on Nov 17, 2026