POST /api/v1/devices/{{device_id}}/action/erase/
This request allows you to erase the device, an MDM command will be triggered.
The following keys are required in the body:
PIN (integer, 6 digits)
Unlock pin, will be required to use the device after an erase.
PreserveDataPlan (bool)
For iOS devices, should the cellular data plan be preserved.
DisallowProximitySetup (bool)
For iOS devices, should proximity setup be allowed during setup assistant.
Servers
- https://SubDomain.clients.us-1.kandji.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
device_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
DisallowProximitySetup |
Boolean | No | |
PIN |
String | No | |
PreserveDataPlan |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.