Erase a device

post

https://{region}.api.jamfcloud.com/device-actions/v1/devices/{id}/erase

Requests that a device erase its content and settings

Required Permissions: destructive-device-actions:execute

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The ID of the device, in UUID format

Body Params

Additional options for erasing the device

Options that control how a device is erased.

preserveDataPlan

boolean

Defaults to false

If 'true', preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists. Applies to mobile devices only.

disallowProximitySetup

boolean

Defaults to false

If 'true', disable Proximity Setup on the next reboot and skip the pane in Setup Assistant. Applies to mobile devices only.

clearActivationLock

boolean

Defaults to false

Clear the activation lock on the device. Applies to mobile devices only.

returnToService

boolean

Defaults to false

If 'true', the device will be returned to service after the erase is complete. Applies to mobile devices only.

string | null

6 to 6

Defaults to null

The six-character PIN for Find My. Applies to computers only.

Headers

X-Environment-Id

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Device erase requested successfully

404The requested device could not be found

422The specified device cannot be erased. This is typically because the device is unmanaged or personal.