Retrieve the list of apps available for blocklisting

Get Apps Present in Repository for Blocklisting

Endpoints

get /api/v1/mdm/blacklist/apps

Copy full URL

Request URL

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

Scope

MDMInventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Query Parameters

querystringOptional

Free-text query string used for advanced filtering of the resource

identifierstringOptional

Bundle/package identifier of the application (e.g., com.zoho.mdm)

platformstringOptional

Filter results by device platform. Allowed values: 1=iOS, 2=Android, 3=Windows, 4=macOS, 6=tvOS

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/v1/mdm/blacklist/apps?query=SOME_STRING_VALUE&identifier=SOME_STRING_VALUE&platform=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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?query=SOME_STRING_VALUE&identifier=SOME_STRING_VALUE&platform=SOME_STRING_VALUE"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/blacklist/apps?query=SOME_STRING_VALUE&identifier=SOME_STRING_VALUE&platform=SOME_STRING_VALUE", headers=headers)

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

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


    parameters = "query=value" + "&" + "identifier=value" + "&" + "platform=value";

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/blacklist/apps" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/blacklist/apps?query=SOME_STRING_VALUE&identifier=SOME_STRING_VALUE&platform=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

appsJSON Array

Array of apps available for blocklisting

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

List of apps available for blocklisting across multiple platforms

Copied!

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

▼ Show full

No apps available for blocklisting

Copied!

  {
    "apps": []
  }

▼ Show full

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