Add a new Web Content Filter payload configuration to an existing profile

To create Mac Web Content Filter policy

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy

Scope

MDMOnDemand.MDMDeviceMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json

JSON object

Hide Sub-Attributes

enable_auto_filterbooleanOptional

Whether Apple's built-in automatic content filter is enabled for limiting access to adult web content. Default: true

malicious_content_filterbooleanOptional

Whether the built-in malicious content filter (fraudulent/phishing site detection) is enabled. Default: true

url_filter_typebooleanOptional

URL filtering mode. true = Allowlist (only listed URLs are accessible), false = Blocklist (listed URLs are blocked, all others allowed)

create_bookmarksbooleanOptional

Whether to automatically create Safari bookmarks for allowed/bookmarked URLs. Default: false

filter_browserbooleanOptional

Whether the web content filter applies to Safari browser traffic. Default: true

filter_typeintegerOptional

Web content filter type. Allowed values: 3=Plugin

filter_socketbooleanOptional

Whether the filter plugin also inspects socket-level (non-HTTP) traffic. Default: false

organizationstringOptional

Organization name displayed to the user, identifying who manages the web content filter

payload_certificate_uuidstringOptional

UUID of the certificate payload used by the web content filter plugin for identity verification

certificate_idlongOptional

Certificate ID obtained from the Certificates API.

plugin_bundle_idstringOptional

Bundle identifier of the Content Filter provider app or plugin (e.g., com.vendor.contentfilter)

server_addressstringOptional

Server address (hostname or URL) for the web content filter plugin to connect to

user_def_namestringOptional

User-defined display name for the web content filter configuration

passwordstringOptional

Password

user_namestringOptional

User Name

filter_data_bundle_idstringOptional

Bundle identifier of the Network Extension provider that handles content filtering data

filter_data_code_reqstringOptional

Code signing requirement string for the filter data provider extension

filter_gradeintegerOptional

Web content filter grade level. Default: 0

filter_packetbooleanOptional

Whether packet-level (network layer) filtering is enabled in addition to content filtering

filter_packet_bundle_idstringOptional

Bundle identifier of the Network Extension provider that handles packet-level filtering

filter_packet_code_reqstringOptional

Code signing requirement string for the filter packet provider extension

custom_dataJSON arrayOptional

List of custom key-value pairs for the web content filter plugin

Show Sub-Attributes

JSON object

Show Sub-Attributes

custom_keystringOptional

Custom configuration key name

custom_valuestringOptional

Custom configuration key value

url_detailsJSON arrayOptional

List of URL bookmarks for the web content filter. Allowlist / Blocklist URLs.

Show Sub-Attributes

JSON object

Show Sub-Attributes

bookmark_pathstringOptional

Folder path for the bookmark

urlstringOptional

URL of the bookmark

bookmark_titlestringOptional

Display title of the bookmark

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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/profiles/{profile_id}/payloads/macwebcontentfilterpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy", 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();

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body

Add Web Content Filter payload to the profile

Copied!

  {
    "certificate_id": 1,
    "create_bookmarks": false,
    "filter_browser": true,
    "payload_certificate_uuid": "value",
    "url_filter_type": true,
    "filter_type": 1,
    "organization": "value",
    "enable_auto_filter": true,
    "filter_socket": false,
    "malicious_content_filter": true
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

enable_auto_filterboolean

Whether Apple's built-in automatic content filter is enabled for limiting access to adult web content. Default: true

malicious_content_filterboolean

Whether the built-in malicious content filter (fraudulent/phishing site detection) is enabled. Default: true

url_filter_typeboolean

URL filtering mode. true = Allowlist (only listed URLs are accessible), false = Blocklist (listed URLs are blocked, all others allowed)

create_bookmarksboolean

Whether to automatically create Safari bookmarks for allowed/bookmarked URLs. Default: false

filter_browserboolean

Whether the web content filter applies to Safari browser traffic. Default: true

filter_typestring

Web content filter type. Allowed values: 3=Plugin

filter_socketboolean

Whether the filter plugin also inspects socket-level (non-HTTP) traffic. Default: false

organizationstring

Organization name displayed to the user, identifying who manages the web content filter

payload_certificate_uuidstring

UUID of the certificate payload used by the web content filter plugin for identity verification

certificate_idlong

Certificate ID obtained from the Certificates API

plugin_bundle_idstring

Bundle identifier of the Content Filter provider app or plugin (e.g., com.vendor.contentfilter)

server_addressstring

Server address (hostname or URL) for the web content filter plugin to connect to

user_def_namestring

User-defined display name for the web content filter configuration

passwordstring

Password

user_namestring

User Name

filter_data_bundle_idstring

Bundle identifier of the Network Extension provider that handles content filtering data

filter_data_code_reqstring

Code signing requirement string for the filter data provider extension

filter_gradestring

Web content filter grade level. Default: 0

filter_packetboolean

Whether packet-level (network layer) filtering is enabled in addition to content filtering

filter_packet_bundle_idstring

Bundle identifier of the Network Extension provider that handles packet-level filtering

filter_packet_code_reqstring

Code signing requirement string for the filter packet provider extension

custom_dataJSON array

List of custom key-value pairs for the web content filter plugin

Show Sub-Attributes

JSON object

Show Sub-Attributes

custom_keystring

Custom configuration key name

custom_valuestring

Custom configuration key value

url_detailsJSON array

List of URL bookmarks for the web content filter. Allowlist / Blocklist URLs.

Show Sub-Attributes

JSON object

Show Sub-Attributes

bookmark_pathstring

Folder path for the bookmark

urlstring

URL of the bookmark

bookmark_titlestring

Display title of the bookmark

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Web Content Filter payload successfully added

Copied!

  {
    "certificate_id": 1,
    "create_bookmarks": false,
    "filter_browser": true,
    "payload_certificate_uuid": "value",
    "payload_id": 9007199254741000,
    "url_filter_type": true,
    "filter_type": 1,
    "organization": "value",
    "enable_auto_filter": true,
    "filter_socket": false,
    "malicious_content_filter": true
  }

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