Skip to main content
POST
/
devices
/
{deviceId}
/
wipe
Wipe a device
curl --request POST \
  --url https://api.getprimo.com/devices/{deviceId}/wipe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wipeType": "SOFT"
}
'
{
  "success": true,
  "platform": "ANDROID",
  "message": "<string>",
  "wipeType": "SOFT"
}
Key: Write Scope: Company

Authorizations

​
Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

​
deviceId
string
required

Body

application/json
​
wipeType
enum<string>

Type of wipe to perform. Only applicable for Windows devices. SOFT resets the device but preserves user data, HARD performs a complete factory reset. Ignored for other platforms.

Available options:
SOFT,
HARD

Response

default - application/json
​
success
boolean
required
​
platform
enum<string>
required

The platform of the wiped device

Available options:
ANDROID,
IOS,
MACOS,
WINDOWS,
LINUX,
CHROME_OS,
IPADOS,
UNKNOWN
​
message
string
required

A human-readable description of the wipe operation

​
wipeType
enum<string> | null

The type of wipe that was performed. Only present for Windows devices (SOFT or HARD). Null for other platforms.

Available options:
SOFT,
HARD