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 Web Content Filter policy payload item

Request URL

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

Scope

MDMOnDemand.MDMDeviceMgmt.READCopied!

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webcontentfilterpolicy/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
▼ 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

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.