Send Action to Bulk Devices
This request sends an action to multiple devices. The possible actions are:
- Lock or unlock one or more devices.
- Retire one or more devices.
- Wipe one or more devices.
- Wake up the Ivanti EPMM client on one or more devices, to force the clients to check in with Ivanti EPMM.
Ivanti EPMM validates that the request has a valid action and valid devices, and then sends the response. Ivanti EPMM performs the actions after sending the response. You can view the actions taken by looking at Logs & Events | All Logs in the Admin Portal.
If the requested action is invalid, Ivanti EPMM sends a response so indicating. If some devices are invalid, the response lists them, but Ivanti EPMM will still take the action on the valid devices.
Note: The UNLOCK bulk request is the exception. In this case, Ivanti EPMM performs the action before sending the response.
Example:
A LOCK request on two valid devices:
https://<Ivanti EPMM>/api/v1/dm/bulk/devices/LOCK?deviceUuids=1ac8bd81-4ab9-4e3e-b3a8-0c4f70521d23&deviceUuids=ab7e93f4-90e2-485b-82b9-7a030ef7d985
The resulting response:
<deviceManagementWebServiceResponse>
<messages/>
</deviceManagementWebServiceResponse>
URI: https:///api/v1/dm/bulk/devices/ | |
|---|---|
Http Method: | POST |
Format: | xml, json |
Request: | |
actiontype | Required. Specify one of these action types: LOCK UNLOCK WAKEUP_DEVICE RETIRE WIPE Note: These values are all capital letters. |
deviceUuids | Required. List each device uuid as a query parameter that has the name deviceUuids. By default, the maximum number of device uuids you can list is 20,000. You can configure this value by setting the variable bulk.api.maxdeviceuuids in the file mifs.properties. This file is located in the directory /mi/tomcat-properties in the Linux system in which Ivanti EPMM is running. Warning: The name of the parameter is deviceUuids, with an “s” at the end. |
Response Status Code: | |
‘404 – No Data Found’ | There is no data. |
‘200 – OK’ | Data is present and the response is returned. |
Response: | |
< deviceManagementWebServiceResponse > | |
<messages> | Status information, if any. Also specifies errors in the request, if any. If Ivanti EPMM has no status or errors to report, this field is empty. |
<message>Invalid action</message> | If you do not capitalize the action or misspell it, this field contains the value “Invalid action”. |
<invalidDevices> | If the request contains one or more invalid device uuids, this field lists them. |
<uuid> 1ac8bd81-4ab9-4e3e-b3a8-0c4f70521d23</uuid> | |
<uuid> 623094f9-645b-4ecf-8840-78597cc1254b</uuid> | |
</invalidDevices> | |
<passcodes> | Only for the UNLOCK action. |
<passcode> | |
<uuid>1ac8bd81-4ab9-4e3e-b3a8-0c4f70521d23</uuid> | The device uuid. |
<name>jdoe:Android:6505551212</name> | The concatenation of the device’s user’s name, device platform, and phone number. |
<value>Q</value> | For iOS devices: Q – The device is MDM managed and has a passcode. F – The device is MDM managed but has no passcode. For Android devices: Q – The device has a passcode. F – The device has no passcode. For Blackberry devices: Passcode to unlock the device. If value is empty, then the device was most likely locked with the user-set passcode. |
</passcode> | |
</passcodes> | |
<failedDevices> | Only for the UNLOCK action. |
<message> | |
| Message contents indicates the device for which the unlock failed. |
</message> | |
</failedDevices> | |
< /deviceManagementWebServiceResponse> | |