Erase a Mobile Device

post

https://{region}.api.jamfcloud.com/pro/v2/mobile-devices/{id}/erase

Required Permissions: destructive-device-actions:execute

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Id of the Mobile Device to erase

Body Params

Options for eraseDevice command

preserveDataPlan

boolean

Defaults to false

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

disallowProximitySetup

boolean

Defaults to false

If 'true', disable Proximity Setup on the next reboot and skip the pane in Setup Assistant.

clearActivationLock

boolean

Defaults to false

Clear the activation lock on the device.

returnToService

boolean

Defaults to false

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

Headers

X-Tenant-Id

uuid

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

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

X-Environment-Id

uuid

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

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

403

Insufficient privileges to perform this action.

404

Mobile device not found.

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200Erase command was queued for this device.

400Return to service requirements not met.

500Failure, unable to queue command.