Clear app data on multiple devices or groups simultaneously

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

initiates bulk clear app data

Request URL

https://{server-hostname}:8383/api/v1/mdm/actions/clear_app_data

Scope

MDMInventory.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
devicesarrayMandatory

Array of device IDs to clear app data on. Fetch from Get Device List

groupsarrayOptional

Array of group IDs whose devices should have app data cleared

clear_data_for_all_appsbooleanOptional

Whether to clear data for all apps. If false, use app_ids to specify which apps

app_idsarrayOptional

Array of app IDs whose data should be cleared (used when clear_data_for_all_apps is false). Obtain from the Get App List response

inclusionbooleanOptional

If true, clear data only for the specified app_ids; if false, clear data for all apps except the specified ones

reason_messagestringOptional

Reason to execute bulk action

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/actions/clear_app_data \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"inclusion":true,"clear_data_for_all_apps":false,"devices":["9508000000013121"],"reason_message":"Clearing app data due to app malfunction","app_ids":[9007199254741000,9007199254741002],"groups":[]}'

Sample Request Body

Clear app data on multiple devices

Copied!
  {
    "inclusion": true,
    "clear_data_for_all_apps": false,
    "devices": [
      "9508000000013121"
    ],
    "reason_message": "Clearing app data due to app malfunction",
    "app_ids": [
      9007199254741000,
      9007199254741002
    ],
    "groups": []
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
success_listJSON Array

List of devices where the command was sent successfully

Show Sub-Attributes
JSON Object
Show Sub-Attributes
device_idstring

Device identifier

remarksstring

Remarks about the command execution for this device

statusstring

Command status for this device (e.g., SCHEDULED, NOT_APPLICABLE)

total_countinteger

Total count of devices selected for the bulk action

not_applicable_countinteger

Count of devices where the command is not applicable

success_countinteger

Count of devices where the command was successfully initiated

na_listJSON Array

List of devices where the command is not applicable

Show Sub-Attributes
JSON Object
Show Sub-Attributes
device_idstring

Device identifier

remarksstring

Remarks about the command execution for this device

statusstring

Command status for this device (e.g., SCHEDULED, NOT_APPLICABLE)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Bulk action result with success and not-applicable lists

Copied!
  {
    "success_list": [
      {
        "device_id": "9508000000013121",
        "remarks": "--",
        "status": "SCHEDULED"
      }
    ],
    "total_count": 3,
    "not_applicable_count": 1,
    "success_count": 1,
    "na_list": [
      {
        "device_id": "9508000000013691",
        "remarks": "Device is unmanaged",
        "status": "NOT_APPLICABLE"
      }
    ]
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.