Retrieve the full configuration details of a Web Content Filter payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get Mac Web Content Filter policy payload item

Request URL

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

Scope

MDMOnDemand.MDMDeviceMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- 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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macwebcontentfilterpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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

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

Full configuration details of Web Content Filter payload item

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