post https://yourServer.jamfcloud.com/JSSResource/mobiledevicecommands/command
The chart below includes additional requirements for usage of specific commands
| command | Parameters | Requirements | Values |
|---|---|---|---|
| DeviceName | device_name | Supervised Device | string |
| DeviceLocation | N/A | Supervised and in lost mode | N/A |
| DeviceLock | lock_message | optional | string |
| DisableLostMode | N/A | Supervised and in lost mode | N/A |
| EnableLostMode | lost_mode_message | Supervised device (required if lost_mode_phone is not set) | string |
| EnableLostMode | lost_mode_phone | Supervised device (required if lost_mode_message is not set) | string |
| EnableLostMode | lost_mode_footnote | optional | string |
| EnableLostMode | always_enforce_lost_mode | optional (defaults to 'true') | boolean |
| EnableLostMode | lost_mode_with_sound | optional (defaults to 'false') | boolean |
| EraseDevice (deprecated on 2023-06-21) | preserve_data_plan | optional (defaults to 'false') | boolean |
| EraseDevice (deprecated on 2023-06-21) | disallow_proximity_setup | optional (defaults to 'false') | boolean |
| EraseDevice (deprecated on 2023-06-21) | clear_activation_lock | optional (defaults to 'false') | boolean |
| PasscodeLockGracePeriod | passcode_lock_grace_period | Shared iPad | seconds (integer) |
| PlayLostModeSound | N/A | Supervised and in lost mode | N/A |
| RestartDevice | N/A | Supervised device | N/A |
| ScheduleOSUpdate (deprecated on 2022-10-17) | install_action | iOS 9 - 10.2, enrolled via a Prestage enrollment; and/or iOS 10.3 or later; tvOS 12 or later | 1 = Download the update for users to install, 2 = Download and install the update, and restart devices after installation |
| ScheduleOSUpdate (deprecated on 2022-10-17) | product_version | iOS 11.3 or later, tvOS 12.2 or later | string |
| SettingsDisableBluetooth (deprecated on 2024-04-24) | N/A | iOS 11.3+ and Supervised | N/A |
| SettingsEnableBluetooth (deprecated on 2024-04-24) | N/A | iOS 11.3+ and Supervised | N/A |
| ShutDownDevice | N/A | Supervised device | N/A |
| Wallpaper | wallpaper_settings | Supervised device | 1 = Lock screen, 2 = Home screen, 3 = both |
| Wallpaper | wallpaper_id | Supervised device (required if wallpaper_content is not set) | Jamf Pro icon ID (integer) |
| Wallpaper | wallpaper_content | Supervised device (required if wallpaper_id is not set) | base64 encoded PNG or JPEG |
| RefreshCellularPlans | e_sim_server_url | N/A | This URL is obtained from each carrier separately |
Below is a complete list of the supported values for the command element.
- BlankPush
- ClearPasscode
- ClearRestrictionsPassword (deprecated)
- DeviceLocation
- DeviceLock
- DeviceName
- DisableLostMode
- EnableLostMode
- EraseDevice (deprecated)
- PasscodeLockGracePeriod
- PlayLostModeSound
- RefreshCellularPlans
- RestartDevice
- ScheduleOSUpdate (deprecated)
- SettingsDisableDataRoaming (deprecated)
- SettingsDisableVoiceRoaming (deprecated)
- SettingsEnableDataRoaming (deprecated)
- SettingsEnableVoiceRoaming (deprecated)
- ShutDownDevice
- UnmanageDevice (deprecated)
- UpdateInventory
- Wallpaper
Below you will find a list of sample request bodies for commands that have additional parameters beyond the command.
<mobile_device_command>
<general>
<command>DeviceName</command>
<device_name>My iPad</device_name>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>DeviceLock</command>
<lock_message>Sample Message</lock_message>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>EnableLostMode</command>
<lost_mode_message>This device has been reported as lost and its location has been identified, please return before authorities arrive.</lost_mode_message>
<lost_mode_phone>555-555-5555</lost_mode_phone>
<lost_mode_footnote>This is an optional footnote</lost_mode_footnote>
<always_enforce_lost_mode>false</always_enforce_lost_mode>
<lost_mode_with_sound>false</lost_mode_with_sound>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>EraseDevice</command>
<preserve_data_plan>false</preserve_data_plan>
<disallow_proximity_setup>false</disallow_proximity_setup>
<clear_activation_lock>false</clear_activation_lock>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>PasscodeLockGracePeriod</command>
<passcode_lock_grace_period>60</passcode_lock_grace_period>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>ScheduleOSUpdate</command>
<install_action>2</install_action>
<product_version>12.5.5</product_version>
</general>
<mobile_devices>
<mobile_device>
<id>5</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>
<mobile_device_command>
<general>
<command>Wallpaper</command>
<wallpaper_setting>1</wallpaper_setting>
<wallpaper_id>1</wallpaper_id>
<wallpaper_content></wallpaper_content>
</general>
<mobile_devices>
<mobile_device>
<id>4</id>
</mobile_device>
</mobile_devices>
</mobile_device_command>