Erase Device
This endpoint sends an MDM command to erase the device.
Request Body Parameters: application/json
PIN - string - PIN (6 digits)
- Unlock pin, will be required to use the device after an erase.
PreserveDataPlan - boolean
- If present on the device, preserve the data plan on an iPhone or iPad with eSIM functionality. Available in iOS 11 and later.
DisallowProximitySetup - boolean
- For iOS devices, should proximity setup be allowed during setup assistant. Available in iOS 11 and later. Prior to iOS 14, do not use this key with any other key.
Responses codes
- 200 OK
- 400 Bad Request
- "Command already running" - The command may already be running in a Pending state waiting on the device.
- 401 Unauthorized
- Invalid access token. This can happen if the token was revoked, the required permissions are missing, or the token has expired.
- 404 Not found
- Unable to locate the resource in the Kandji instance.
Parameters
| Parameter | Description |
|---|---|
| Device ID | - |
| Disallow Proximity Setup | - |
| PIN | - |
| Preserve Data Plan | - |
Workflow Library Example
Erase Device with Kandji and Send Results Via Email
Preview this Workflow on desktop