Add a new app to the blocklist repository

Add new app to repository for blocklisting

Endpoints

post /api/v1/mdm/blacklist/apps

Copy full URL

Request URL

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

Scope

MDMInventory.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Query Parameters

validatebooleanOptional

When true, only validates the request and returns validation errors without persisting changes. Default: false

- Request Body

application/json

JSON Object

Hide Sub-Attributes

appsJSON ArrayMandatory

Array of app objects to add to the blocklist repository

Show Sub-Attributes

JSON Object

Show Sub-Attributes

identifierstringOptional

Unique identifier (bundle ID / package name) of the app (e.g., com.manageengine.mdm.android)

platformintegerOptional

Platform of the app: 1 = iOS, 2 = Android, 3 = Windows

appnamestringOptional

Display name of the app (e.g., Zylker MDM)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url 'https://appdomain/api/v1/mdm/blacklist/apps?validate=SOME_BOOLEAN_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"apps":[{"identifier":"com.manageengine.mdm.android","appname":"Zylker MDM","platform":2},{"identifier":"com.zylker.chatapp","appname":"Chat App","platform":1}]}'

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/blacklist/apps?validate=SOME_BOOLEAN_VALUE"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"apps\":[{\"identifier\":\"com.manageengine.mdm.android\",\"appname\":\"Zylker MDM\",\"platform\":2},{\"identifier\":\"com.zylker.chatapp\",\"appname\":\"Chat App\",\"platform\":1}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"apps\":[{\"identifier\":\"com.manageengine.mdm.android\",\"appname\":\"Zylker MDM\",\"platform\":2},{\"identifier\":\"com.zylker.chatapp\",\"appname\":\"Chat App\",\"platform\":1}]}"

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

conn.request("POST", "/api/v1/mdm/blacklist/apps?validate=SOME_BOOLEAN_VALUE", payload, headers)

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

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


    parameters = "validate=value";

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

    data=Map();
    data_apps=List();
    data_apps_item1=Map();
    data_apps_item1.put("identifier","value");
    data_apps_item1.put("platform","1");
    data_apps_item1.put("appname","value");
    data_apps.add(data_apps_item1);
    data.put("apps",data_apps);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/blacklist/apps" + "?" + parameters
        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/blacklist/apps?validate=SOME_BOOLEAN_VALUE' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"apps":[{"identifier":"com.manageengine.mdm.android","appname":"Zylker MDM","platform":2},{"identifier":"com.zylker.chatapp","appname":"Chat App","platform":1}]}'

Sample Request Body

Add two apps (Android and iOS) to the blocklist repository

Copied!

  {
    "apps": [
      {
        "identifier": "com.manageengine.mdm.android",
        "appname": "Zylker MDM",
        "platform": 2
      },
      {
        "identifier": "com.zylker.chatapp",
        "appname": "Chat App",
        "platform": 1
      }
    ]
  }

▼ Show full

Add a single Android app to the blocklist repository

Copied!

  {
    "apps": [
      {
        "identifier": "com.zylker.socialapp",
        "appname": "Social App",
        "platform": 2
      }
    ]
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

appsJSON Array

Array of apps that were added to the blocklist repository with their assigned app group IDs

Show Sub-Attributes

JSON Object

Show Sub-Attributes

identifierstring

Unique identifier (bundle ID / package name) of the app

appgroupidlong

App group ID used to reference the app in other API calls

platforminteger

Platform of the app: 1 = iOS, 2 = Android, 3 = Windows

appnamestring

Display name of the app

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Apps successfully added to the blocklist repository with assigned app group IDs

Copied!

  {
    "apps": [
      {
        "identifier": "com.manageengine.mdm.android",
        "appname": "Zylker MDM",
        "appgroupid": 9007199254741064,
        "platform": 2
      },
      {
        "identifier": "com.zylker.chatapp",
        "appname": "Chat App",
        "appgroupid": 9007199254741068,
        "platform": 1
      }
    ]
  }

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