HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Creates a new mobile device command

The chart below includes additional requirements for usage of specific commands

commandParametersRequirementsValues
DeviceNamedevice_nameSupervised Devicestring
DeviceLocationN/ASupervised and in lost modeN/A
DeviceLocklock_messageoptionalstring
DisableLostModeN/ASupervised and in lost modeN/A
EnableLostModelost_mode_messageSupervised device (required if lost_mode_phone is not set)string
EnableLostModelost_mode_phoneSupervised device (required if lost_mode_message is not set)string
EnableLostModelost_mode_footnoteoptionalstring
EnableLostModealways_enforce_lost_modeoptional (defaults to 'true')boolean
EnableLostModelost_mode_with_soundoptional (defaults to 'false')boolean
EraseDevicepreserve_data_planoptional (defaults to 'false')boolean
EraseDevicedisallow_proximity_setupoptional (defaults to 'false')boolean
EraseDeviceclear_activation_lockoptional (defaults to 'false')boolean
PasscodeLockGracePeriodpasscode_lock_grace_periodShared iPadseconds (integer)
PlayLostModeSoundN/ASupervised and in lost modeN/A
RestartDeviceN/ASupervised deviceN/A
ScheduleOSUpdateinstall_actioniOS 9 - 10.2, enrolled via a Prestage enrollment; and/or iOS 10.3 or later; tvOS 12 or later1 = Download the update for users to install, 2 = Download and install the update, and restart devices after installation
ScheduleOSUpdateproduct_versioniOS 11.3 or later, tvOS 12.2 or laterstring
SettingsDisableBluetoothN/AiOS 11.3+ and SupervisedN/A
SettingsEnableBluetoothN/AiOS 11.3+ and SupervisedN/A
ShutDownDeviceN/ASupervised deviceN/A
Wallpaperwallpaper_settingsSupervised device1 = Lock screen, 2 = Home screen, 3 = both
Wallpaperwallpaper_idSupervised device (required if wallpaper_content is not set)Jamf Pro icon ID (integer)
Wallpaperwallpaper_contentSupervised device (required if wallpaper_id is not set)base64 encoded PNG or JPEG
RefreshCellularPlanse_sim_server_urlN/AThis URL is obtained from each carrier separately

Below is a complete list of the supported values for the command element.

  • BlankPush
  • ClearPasscode
  • ClearRestrictionsPassword
  • DeviceLocation
  • DisableLostMode
  • EnableLostMode
  • EraseDevice
  • PasscodeLockGracePeriod
  • PlayLostModeSound
  • RefreshCellularPlans
  • RestartDevice
  • Settings
  • SettingsDisableAppAnalytics
  • SettingsDisableBluetooth
  • SettingsEnablePersonalHotspot
  • SettingsDisablePersonalHotspot
  • SettingsDisableDataRoaming
  • SettingsDisableDiagnosticSubmission
  • SettingsDisableVoiceRoaming
  • SettingsEnableAppAnalytics
  • SettingsEnableBluetooth
  • SettingsEnableDataRoaming
  • SettingsEnableDiagnosticSubmission
  • SettingsEnableVoiceRoaming
  • ShutDownDevice
  • UnmanageDevice
  • UpdateInventory
<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>
Language
Credentials
Basic
base64
: