External DocumentationTo learn more, visit the Zscaler Internet Access documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Action | Action taken when traffic matches rule criteria. Note: The ISOLATE action is available only if Cloud Browser Isolation is enabled for your organization.The protocol parameter is required for all actions except ISOLATE. |
| Cbi Profile ID | The universally unique identifier (UUID) for the browser isolation profile. |
| Cbi Profile Name | The name of the browser isolation profile. |
| Cbi Profile URL | The browser isolation profile URL. |
| Order | Order of execution of rule with respect to other URL Filtering rules. |
| Protocols | Select the protocol to apply to the rule. Note: This parameter is required for all action values except ISOLATE. |
| Rank | Admin rank of the admin who creates this rule. Note: The default value is 7 unless a specific Admin Rank is assigned. |
| Rule Description | Additional information about the URL Filtering rule. |
| Rule ID | The URL Filtering Rule ID. |
| Rule Name | The rule’s name. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Block Override | When selected, a BLOCK action triggered by the rule could be overridden. If selected and both Override Group and Override Users are not set, the BLOCK triggered by this rule could be overridden for any users. If Block Override is not selected, BLOCK action cannot be overridden. |
| Cbi Profile Default Profile | Indicates whether this is a default browser isolation profile. Zscaler sets this field. |
| Ciparule | If set to true, the CIPA Compliance rule is enabled. |
| Departments | The object of departments for which rule must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Device Groups | This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Devices | The object of devices for which rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation. For more information about how to use this parameter visit Zscaler’s Documentation. |
| End User Notification URL | URL of end user notification page to be displayed when the rule is matched. Not applicable if either ‘overrideUsers’ or ‘overrideGroups’ is specified. |
| Enforce Time Validity | Whether to enforce a set a validity time period for the URL Filtering rule. |
| Groups | The object of groups for which rule must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Labels | The URL Filtering rule’s label. Rule labels allow you to logically group your organization’s policy rules. Policy rules that are not associated with a rule label are grouped under the Untagged label. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Last Modified By Extensions | Additional information about the entity that modified the rule last. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Last Modified By External ID | The external ID of the entity that modified the rule last. |
| Last Modified By ID | The ID of the entity that modified the rule last. |
| Last Modified By Name | The name of the entity that modified the rule last. |
| Last Modified Time | When the rule was last modified. |
| Location Groups | The object of the location groups to which the rule must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Locations | The object of locations for which rule must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Override Groups | The object of groups for which this rule can be overridden. Applicable only if Block Override is selected and action is BLOCK. If this Override Groups is not set, BLOCK action can be overridden for any group. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Override Users | The object of users for which this rule can be overridden. Applicable only if Block Override is selected, action is BLOCK and Override Groups is not set. If Override Users is not set, BLOCK action can be overridden for any user.For more information about how to use this parameter visit Zscaler’s Documentation. |
| Request Methods | Request method for which the rule must be applied. If not set, rule is applied to all methods. |
| Size Quota | Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to ‘BLOCK’, this field is not applicable. |
| State | The rule’s state. |
| Time Quota | Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to ‘BLOCK’, this field is not applicable. |
| Time Windows | The object of time intervals during which rule must be enforced. For more information about how to use this parameter visit Zscaler’s Documentation. |
| URL Categories 1 | A comma-separated list of URL categories that the rule applies to. Note: URL Categories 1 and 2 must both match (AND logic) to trigger the policy. To see a list of possible values visit Zscaler’s Documentation. |
| URL Categories 2 | A comma-separated list of URL categories that the rule applies to. Note: URL Categories 1 and 2 must both match (AND logic) to trigger the policy. To see a list of possible values visit Zscaler’s Documentation. |
| Users | The object of users for which rule must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
| Validity End Time | If Enforce Time Validity is set to true, the URL Filtering rule ceases to be valid on this end date and time. |
| Validity Start Time | If Enforce Time Validity is set to true, the URL Filtering rule is valid starting on this date and time. |
| Validity Time Zone ID | If Enforce Time Validity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. |
| Workload Groups | The list of preconfigured workload groups to which the policy must be applied. For more information about how to use this parameter visit Zscaler’s Documentation. |
Example Output
{
"id": 0,
"name": "string",
"order": 0,
"protocols": [
"SMRULEF_ZPA_BROKERS_RULE"
],
"locations": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groups": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"departments": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"users": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"urlCategories": [
"ANY"
],
"urlCategories2": [
"ANY"
],
"state": "DISABLED",
"timeWindows": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"workloadGroups": [
{
"id": 0,
"name": "string",
"description": "string",
"expressionJson": {
"expressionContainers": [
{
"tagType": "ANY",
"operator": "AND",
"tagContainer": {
"tags": [
{
"key": "string",
"value": "string"
}
],
"operator": "AND"
}
}
]
},
"expression": "string",
"lastModifiedTime": 0,
"lastModifiedBy": {
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}
],
"rank": 0,
"requestMethods": [
"OPTIONS"
],
"endUserNotificationUrl": "string",
"overrideUsers": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"overrideGroups": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"blockOverride": false,
"timeQuota": 0,
"sizeQuota": 0,
"description": "string",
"locationGroups": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"labels": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"validityStartTime": 0,
"validityEndTime": 0,
"validityTimeZoneId": "string",
"lastModifiedTime": 0,
"lastModifiedBy": {
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"enforceTimeValidity": true,
"devices": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"deviceGroups": [
{
"id": 0,
"name": "string",
"externalId": "string",
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"deviceTrustLevels": [
"ANY"
],
"action": "BLOCK",
"cbiProfile": {
"id": "string",
"name": "string",
"url": "string",
"defaultProfile": true
},
"ciparule": false
}
Workflow Library Example
Add Url Filtering Rule with Zscaler Internet Access and Send Results Via Email