v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB

Device

Create box by device

Create a new box using a physical device

post/devices/{deviceId}/box

Path parameters

deviceIdstring required

Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Device ID

Request body

forceboolean

If true, the device will be forcibly created as a new Box, which will forcibly terminate any existing box that is currently using this device. If false, an error will be thrown with HTTP 423 status code when the device is already occupied by a box.

Example request

{
  "force": true
}

Response

string required