Shut down multiple devices or groups simultaneously

initiates bulk shutdown

Endpoints

post /api/v1/mdm/actions/shutdown

Copy full URL

Request URL

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

Scope

MDMInventory.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

devicesarrayMandatory

Array of device IDs to shut down. Fetch from Get Device List

actionsarrayOptional

Action name. Must be 'shutdown'

groupsarrayOptional

Array of group IDs whose devices should be shut down

reason_messagestringOptional

Reason message for the bulk action

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/actions/shutdown \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"devices":["9508000000013121","9508000000013691"],"reason_message":["Routine maintenance"],"groups":["9007199254741597","9007199254741595"],"actions":["shutdown"]}'

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/actions/shutdown"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"devices\":[\"9508000000013121\",\"9508000000013691\"],\"reason_message\":[\"Routine maintenance\"],\"groups\":[\"9007199254741597\",\"9007199254741595\"],\"actions\":[\"shutdown\"]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"devices\":[\"9508000000013121\",\"9508000000013691\"],\"reason_message\":[\"Routine maintenance\"],\"groups\":[\"9007199254741597\",\"9007199254741595\"],\"actions\":[\"shutdown\"]}"

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

conn.request("POST", "/api/v1/mdm/actions/shutdown", 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_devices=List();
    data.put("devices",data_devices);
    data_actions=List();
    data.put("actions",data_actions);
    data_groups=List();
    data.put("groups",data_groups);
    data.put("reason_message","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/actions/shutdown"
        type: POST
        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/actions/shutdown' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"devices":["9508000000013121","9508000000013691"],"reason_message":["Routine maintenance"],"groups":["9007199254741597","9007199254741595"],"actions":["shutdown"]}'

Sample Request Body

Shutdown multiple devices

Copied!

  {
    "devices": [
      "9508000000013121",
      "9508000000013691"
    ],
    "reason_message": [
      "Routine maintenance"
    ],
    "groups": [
      "9007199254741597",
      "9007199254741595"
    ],
    "actions": [
      "shutdown"
    ]
  }

▼ 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.