API Reference

Erase a device

post
https://{region}.apigw.jamf.com/api/device-actions/v1/tenant//devices//erase

Requests that a device erase its content and settings

Required Permissions: execute:pro:device-actions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier

string
required

Path parameter id

Body Params

Additional options for erasing the device

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.

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.

boolean
Defaults to false

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

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.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?