apple_device-management/mdm/commands/device.erase.yaml

title: Erase Device Command
description: Remotely and immediately erase a device.
payload:
  requesttype: EraseDevice
  supportedOS:
    iOS:
      introduced: '4.0'
      accessrights: AllowDeviceErase
      supervised: false
      requiresdep: false
      sharedipad:
        mode: allowed
        devicechannel: true
        userchannel: false
      userenrollment:
        mode: forbidden
    macOS:
      introduced: '10.7'
      accessrights: AllowDeviceErase
      devicechannel: true
      userchannel: false
      supervised: false
      requiresdep: false
      userenrollment:
        mode: forbidden
    tvOS:
      introduced: '10.2'
      accessrights: AllowDeviceErase
      supervised: false
    visionOS:
      introduced: '1.1'
      accessrights: AllowDeviceErase
      supervised: false
      requiresdep: false
      userenrollment:
        mode: forbidden
    watchOS:
      introduced: '10.0'
      accessrights: AllowDeviceErase
      supervised: false
  content: This command allows the server to remotely erase the device. This command
    requires the Device Erase right.
payloadkeys:
- key: PreserveDataPlan
  supportedOS:
    iOS:
      introduced: '11.0'
    macOS:
      introduced: n/a
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, preserve the data plan on an iPhone or iPad with eSIM functionality,
    if one exists.
- key: DisallowProximitySetup
  supportedOS:
    iOS:
      introduced: '11.3'
      sharedipad:
        mode: forbidden
    macOS:
      introduced: n/a
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, disable Proximity Setup on the next reboot and skip the pane
    in Setup Assistant. Prior to iOS 14, don't use this option with any other option.
- key: PIN
  supportedOS:
    iOS:
      introduced: n/a
    macOS:
      introduced: '10.8'
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
  type: <string>
  presence: optional
  content: The six-character PIN for Find My.
- key: ObliterationBehavior
  supportedOS:
    iOS:
      introduced: n/a
    macOS:
      introduced: '12.0'
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
  type: <string>
  presence: optional
  rangelist:
  - Default
  - DoNotObliterate
  - ObliterateWithWarning
  - Always
  content: |-
    This key defines the fallback behavior for erasing a device.

    In macOS 12 and later, this command uses Erase All Content and Settings (EACS) on Mac computers with the Apple M1 chip or the Apple T2 Security Chip. On those devices, if EACS can't run, the device can use obliteration (macOS 11.x behavior). This key has no effect on machines prior to the T2 chip. For a list of supported macs, see [Mac models with the Apple T2 Security Chip](https://support.apple.com/en-us/HT208862).

    Upon receiving this command, the device performs preflight checks to determine if the device is in a state that allows EACS. The `status` of the `EraseDeviceResponse` is either `Acknowledged` or `Error`.

    The following values define the device's fallback behavior:

    - `DoNotObliterate`: If EACS preflight fails, the device responds to the server with an `Error` status and doesn't attempt to erase itself.
      If EACS preflight succeeds, but EACS fails, the device doesn't attempt to erase itself.
    - `ObliterateWithWarning`: If EACS preflight fails, the device responds with an `Acknowledged` status and then attempts to erase itself.
        If EACS preflight succeeds, but EACS fails, the device attempts to erase itself.
    - `Always`: The system doesn't attempt EACS. T2 and later devices always obliterate.
    - `Default`: If EACS preflight fails, the device responds to the server with an `Error` status and then attempts to erase itself.
      If EACS preflight succeeds, but EACS fails, the device attempts to erase itself.
- key: ReturnToService
  supportedOS:
    iOS:
      introduced: '17.0'
    macOS:
      introduced: n/a
    tvOS:
      introduced: '18.0'
    visionOS:
      introduced: '26.0'
    watchOS:
      introduced: n/a
  type: <dictionary>
  presence: optional
  content: The configuration settings for return to service.
  subkeys:
  - key: Enabled
    title: Use return to service
    type: <boolean>
    presence: required
    content: If `true`, the device tries to reenroll itself automatically after erasure.
      The user needs to deactivate all activation locks for this feature to work correctly.
  - key: WiFiProfileData
    type: <data>
    presence: optional
    content: The Wi-Fi profile that installs after erasure when using return to service.
      This is required when the device doesn't have an Ethernet or cellular connection.
  - key: MDMProfileData
    type: <data>
    presence: optional
    content: |-
      The MDM profile that installs after erasure when using return to service. This key is required for all unsupervised devices, as well as supervised devices that don't enroll with Automated Device Enrollment. If provided, the device uses this profile directly instead of fetching it from the server. For devices that enroll with Automated Device Enrollment, this key isn't necessary unless the cloud configuration profile of the device contains the `configuration-web-url` key.

      The cloud configuration still downloads from Apple's servers when the profile contains this key, so the supervision identity, MDM removability, and other settings from the cloud configuration still apply. However, the device doesn't use the specified URL in the cloud configuration to fetch the MDM profile.
  - key: BootstrapToken
    supportedOS:
      iOS:
        introduced: '26.0'
      macOS:
        introduced: n/a
      tvOS:
        introduced: n/a
      visionOS:
        introduced: '26.0'
      watchOS:
        introduced: n/a
    type: <data>
    presence: optional
    content: The bootstrap token the system uses to implement return to service with
      app preservation. Required when enabling return to service through the cloud
      configuration.
  - key: ShouldRetryEnrollment
    supportedOS:
      iOS:
        introduced: '27.0'
      macOS:
        introduced: n/a
      tvOS:
        introduced: n/a
      visionOS:
        introduced: n/a
      watchOS:
        introduced: n/a
    type: <boolean>
    presence: optional
    default: false
    content: If `true`, the device retries service enrollment when the initial enrollment
      fails after erasure.
notes:
- title: ''
  content: |-
    This command allows the server to immediately erase a device, even a locked device, without warning the user. The device sends a response to the server, but it doesn't retry if it isn't successful the first time.

    Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
examples:
- title: Example request and response
  files:
  - request-file: examples/mdm/commands/device.erase/example1.plist
    response-file: examples/mdm/commands/device.erase/example2.plist