Save inactive device policy settings

Endpoints

put /api/v1/mdm/inactive_device_policy_settings

Copy full URL

Request URL

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

Scope

MDMAdmin.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

action_typeintegerMandatory

Action to perform on inactive devices. 0 = No Action (default), 1 = Remove Inactive Devices, 2 = Retire Inactive Devices, 3 = Unassign License

action_thresholdlongOptional

Threshold period in milliseconds to perform the action on an inactive device. Default is 0. Example: 1814400000 (21 days)

inactive_thresholdlongMandatory

Threshold period in milliseconds to move the device to inactive state. Example: 1728000000 (20 days)

notification_typeintegerOptional

To send email notifications when device is inactive, to the assigned user. 0 - No notification, 1 - Notifications only for mobile devices, 2 - Notifications only for computers, 3 - Notification for all devices

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/inactive_device_policy_settings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"action_type":1,"action_threshold":1814400000,"inactive_threshold":1728000000}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/inactive_device_policy_settings"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"action_type\":1,\"action_threshold\":1814400000,\"inactive_threshold\":1728000000}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"action_type\":1,\"action_threshold\":1814400000,\"inactive_threshold\":1728000000}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/inactive_device_policy_settings", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("action_type","1");
    data.put("action_threshold","1");
    data.put("inactive_threshold","1");
    data.put("notification_type","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/inactive_device_policy_settings"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/inactive_device_policy_settings' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"action_type":1,"action_threshold":1814400000,"inactive_threshold":1728000000}'

Sample Request Body

Remove devices inactive for 21 days after 20-day warning threshold

Copied!

  {
    "action_type": 1,
    "action_threshold": 1814400000,
    "inactive_threshold": 1728000000
  }

▼ Show full

Retire devices inactive for 21 days after 20-day warning threshold

Copied!

  {
    "action_type": 2,
    "action_threshold": 1814400000,
    "inactive_threshold": 1728000000
  }

▼ Show full

Set no-action policy with default thresholds

Copied!

  {
    "action_type": 0,
    "action_threshold": 0,
    "inactive_threshold": 1728000000
  }

▼ Show full

Unassign MDM license for devices inactive for 21 days

Copied!

  {
    "action_type": 3,
    "action_threshold": 1814400000,
    "inactive_threshold": 1728000000
  }

▼ Show full

Response Parameters

- HTTP code 204

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Current status. Set to 'acknowledged' if inactive device policy settings were successfully saved

Possible Response Codes

204HTTP code

Sample Response: HTTP 204

Inactive device policy settings saved successfully

Copied!

  {
    "status": "acknowledged"
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | 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.