- API Reference
- Box API
- System settings
Add a CPE device label and bring up its virtual interface
Use this to register a CPE device. Without VLAN the label must be below 100. The interface is created at once. A missing field or a non-numeric label fails with HTTP 500.
POST
/add_new_labelRequest body application/json · required
labelintegerrequired
manustringrequired
addressstringrequired
vlanbooleanrequired
Responses
Result.
statusbooleanrequired
True when the box accepted the request.
msgstringrequired
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.
errorstringoptional
Error name, e.g. internal_server_error or bad_request.
messagestringoptional
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Label must be less than 100 when VLAN is disabled! | Label is 100 or more and vlan is false. | Use a smaller label or enable VLAN. |
Label already exist! | Meant to refuse duplicates; the current check never matches so duplicates are not detected. | Check GET /get_label_list before adding. |