Erase Device Command Options in the Jamf Pro API

Technical Articles
Solution
Application
Content Type
Technical Documentation
Utilities & Services
ft:locale
en-US

The EraseDeviceCommand in the Jamf Pro API allows you to trigger the Erase All Content and Settings option on a computer or mobile device.

You can configure the following options to perform additional actions on the computer or mobile device when you issue the EraseDeviceCommand:
  • Obliteration Behavior (computers only) —

    Use the obliterationBehavior option as a fallback method to erase a computer that is not in a state that allows Erase All Content and Settings to run.

  • Return to Service (mobile devices only) —

    Use the returnToService option to instruct iOS, iPadOS, or tvOS devices to automatically reconnect to Wi-Fi and re-enroll with Jamf Pro after erasure.

To access these features, open the Jamf Pro API and navigate to mdm > v2/mdm/commands > Schema > MdmCommand Request > commandData > oneOf > EraseDeviceCommand.

The following screenshot shows the location of the EraseDeviceCommand options in the Jamf Pro API:

For more information about the Jamf Pro API, see Jamf Pro API Overview in the Jamf Developer Portal.