HomeGuidesRecipesAPI ReferenceChangelog
API Reference

Creates a new mobile device command

The chart below includes additional requirements for usage of specific commands

commandParametersRequirementsValues
DeviceLocationN/ASupervised and in lost modeN/A
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
PasscodeLockGracePeriodpasscode_lock_grace_periodShared iPadseconds (integer)
PlayLostModeSoundN/ASupervised and in lost modeN/A
RestartDeviceN/ASupervised deviceN/A
SettingsDisableBluetoothN/AiOS 11.3+ and SupervisedN/A
SettingsEnableBluetoothN/AiOS 11.3+ and SupervisedN/A
ShutDownDeviceN/ASupervised deviceN/A

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

  • BlankPush
  • ClearPasscode
  • ClearRestrictionsPassword
  • DeviceLocation
  • DisableLostMode
  • EnableLostMode
  • EraseDevice
  • PasscodeLockGracePeriod
  • PlayLostModeSound
  • RestartDevice
  • Settings
  • SettingsDisableAppAnalytics
  • SettingsDisableBluetooth
  • SettingsEnablePersonalHotspot
  • SettingsDisablePersonalHotspot
  • SettingsDisableDataRoaming
  • SettingsDisableDiagnosticSubmission
  • SettingsDisableVoiceRoaming
  • SettingsEnableAppAnalytics
  • SettingsEnableBluetooth
  • SettingsEnableDataRoaming
  • SettingsEnableDiagnosticSubmission
  • SettingsEnableVoiceRoaming
  • ShutDownDevice
  • UnmanageDevice
  • UpdateInventory
Language
Credentials
Basic
base64
: