Modify the configuration of a Web Content Filter payload item within a profile

To modify Web Content Filter policy payload item

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id}

Scope

MDMOnDemand.MDMDeviceMgmt.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

profile_idstringMandatory

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

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json

JSON object

Hide Sub-Attributes

enable_auto_filterbooleanOptional

Enable Auto Filter. Default: true

malicious_content_filterbooleanOptional

Malicious Content Filter. Default: true

url_filter_typebooleanOptional

Url Filter Type. 'true' - Allowlist filter, 'false' - Blocklist filter.

create_bookmarksbooleanOptional

Create Bookmarks. Default: false

filter_browserbooleanOptional

Filter Browser. Default: true

filter_typeintegerOptional

Web content filter type. Allowed values: 1=Built-in Filter, 2=Plugin

filter_socketbooleanOptional

Filter Socket. Default: false

organizationstringOptional

Organization

payload_certificate_uuidstringOptional

Payload Certificate Uuid

certificate_idlongOptional

Certificate ID obtained from the Certificates API

plugin_bundle_idstringOptional

Plugin Bundle Id

server_addressstringOptional

Server Address

passwordstringOptional

Password (sensitive - write-only)

password_idlongOptional

Password Id

user_def_namestringOptional

User Def Name

user_namestringOptional

User Name

permitted_urlsarrayOptional

List of URL strings that can be accessed even if restricted by the blocklist auto-filter

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

upload_typeintegerOptional

Upload Type. Default: 1

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 PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id} \
  --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/webcontentfilterpolicy/payloaditems/{payload_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", 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",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id}", 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/webcontentfilterpolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'

▼ Show full

Sample Request Body

Modify Web Content Filter payload item

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 of the payload item

enable_auto_filterboolean

Enable Auto Filter. Default: true

malicious_content_filterboolean

Malicious Content Filter. Default: true

url_filter_typeboolean

Url Filter Type. 'true' - Allowlist filter, 'false' - Blocklist filter.

create_bookmarksboolean

Create Bookmarks. Default: false

filter_browserboolean

Filter Browser. Default: true

filter_typeinteger

Web content filter type. Allowed values: 1=Built-in Filter, 2=Plugin

filter_socketboolean

Filter Socket. Default: false

organizationstring

Organization

payload_certificate_uuidstring

Payload Certificate Uuid

certificate_idlong

Certificate ID obtained from the Certificates API

plugin_bundle_idstring

Plugin Bundle Id

server_addressstring

Server Address

passwordstring

Password (sensitive - write-only)

password_idlong

Password Id

user_def_namestring

User Def Name

user_namestring

User Name

permitted_urlsarray

List of URL strings that can be accessed even if restricted by the blocklist auto-filter

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

upload_typeinteger

Upload Type. Default: 1

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 item successfully modified

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