BYbymason
device-api

Move Devices

Move devices from one group to another. If the new group has artifacts deployed to it, the device will automatically update to install the new artifacts. If the new group has a different config or the same config on a lower version, the device will perform a Wipe Action.

The move will only succeed if every device listed is of the same device type + API level and the target group is locked to the same device type + API level. A group will be locked to a device type and API level once a project is deployed or a device is moved into the group.

post/v1/default/group/{name}/move

Request

  • Base URL
    https://api.bymason.com
  • Auth
    API key in header Authorization

Path parameters

namestring required

Group name

Query parameters

validateonlyboolean

Validate whether the move can be done or not, but do not perform the move

Response

Move Devices response

willUpdateboolean

Set to true if any of the devices will receive an updated or new artifact after the move occurs. This will happen if the device does not have the same installed artifacts (or different versions) as are deployed to the target group.

willWipeboolean

Set to true if any of the devices will Wipe after the move occurs. This will happen if any of the devices are on a newer config version or a different config than is deployed to the target group.

emptyGroupboolean

Set to true if the target group has not received a project deployment. The devices will not remove their old project in this case.

newProjectstring

The name of the last project deployed to the target group, if a project has been deployed.

newVersionstring

The version of the last project deployed to the target group, if a project has been deployed.

Changes

No recorded changes to this operation across all 1 revision of this API.