GuidesRecipesAPI 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
EraseDevice (deprecated on 2023-06-21)preserve_data_planoptional (defaults to 'false')boolean
EraseDevice (deprecated on 2023-06-21)disallow_proximity_setupoptional (defaults to 'false')boolean
EraseDevice (deprecated on 2023-06-21)clear_activation_lockoptional (defaults to 'false')boolean
PasscodeLockGracePeriodpasscode_lock_grace_periodShared iPadseconds (integer)
PlayLostModeSoundN/ASupervised and in lost modeN/A
RestartDeviceN/ASupervised deviceN/A
ScheduleOSUpdate (deprecated on 2022-10-17)install_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
ScheduleOSUpdate (deprecated on 2022-10-17)product_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
Language
Credentials
Basic
base64
: