UrlFilteringRule
Url Filtering Rule resource for Zscaler Internet Access.
Resource operations
This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.
Quick Start
import zssdk
import logging
# Enable debug logging for UrlFilteringRule
logging.getLogger('zssdk.zia').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific UrlFilteringRule
resource = session.zia.UrlFilteringRule(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
create()
Creates a new UrlFilteringRule. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | No | - |
adaptive_access_profiles | AdaptiveAccessProfileWrapperCollection | No | - |
allow_policy_rule_re_order | boolean | No | - |
authentication_levels | IAMAuthenticationLevelWrapperCollection | No | - |
block_override | boolean | No | - |
browser_eun_template_id | integer | No | - |
capture_flag | string | No | - |
capture_PCAP | boolean | No | - |
cbi_profile | BrowserIsolationProfile | No | - |
cbi_profile_id | integer | No | - |
ciparule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
end_user_notification_url | string | No | - |
enforce_time_validity | boolean | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
http_header_action_profiles | EntityReferenceWrapperCollection | No | - |
http_header_profiles | EntityReferenceWrapperCollection | No | - |
icap_server | EntityReference | No | - |
id | integer | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
order | integer | No | - |
override_groups | EntityReferenceWrapperCollection | No | - |
override_users | EntityReferenceWrapperCollection | No | - |
predefined | boolean | No | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | No | - |
rank | integer | No | - |
request_methods | UrlFilteringRuleRequestMethodsEnumCollection | No | - |
size_quota | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule | boolean | No | - |
template_synced_rule_flag | string | No | - |
time_quota | integer | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
url_categories | stringCollection | No | - |
url_categories2 | stringCollection | No | - |
user_agent_types | UserAgentTypesEnumCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
validity_end_time | integer | No | - |
validity_start_time | integer | No | - |
validity_time_zone_id | string | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
Returns: UrlFilteringRule
Example:
resource = session.zia.UrlFilteringRule()
resource.access_control = "value"
resource.action = "value"
resource.adaptive_access_profiles = [{"aap_index": 3600, "deleted": True, "iam_aap_id": "resource-id", "id": 3600}]
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a UrlFilteringRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.UrlFilteringRule(id="your-resource-id")
resource.delete()
load()
Fetches an existing UrlFilteringRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: UrlFilteringRule
Example:
resource = session.zia.UrlFilteringRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing UrlFilteringRule. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | No | - |
adaptive_access_profiles | AdaptiveAccessProfileWrapperCollection | No | - |
allow_policy_rule_re_order | boolean | No | - |
authentication_levels | IAMAuthenticationLevelWrapperCollection | No | - |
block_override | boolean | No | - |
browser_eun_template_id | integer | No | - |
capture_flag | string | No | - |
capture_PCAP | boolean | No | - |
cbi_profile | BrowserIsolationProfile | No | - |
cbi_profile_id | integer | No | - |
ciparule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
end_user_notification_url | string | No | - |
enforce_time_validity | boolean | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
http_header_action_profiles | EntityReferenceWrapperCollection | No | - |
http_header_profiles | EntityReferenceWrapperCollection | No | - |
icap_server | EntityReference | No | - |
id | integer | Yes | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
order | integer | No | - |
override_groups | EntityReferenceWrapperCollection | No | - |
override_users | EntityReferenceWrapperCollection | No | - |
predefined | boolean | No | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | No | - |
rank | integer | No | - |
request_methods | UrlFilteringRuleRequestMethodsEnumCollection | No | - |
size_quota | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule | boolean | No | - |
template_synced_rule_flag | string | No | - |
time_quota | integer | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
url_categories | stringCollection | No | - |
url_categories2 | stringCollection | No | - |
user_agent_types | UserAgentTypesEnumCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
validity_end_time | integer | No | - |
validity_start_time | integer | No | - |
validity_time_zone_id | string | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
Returns: UrlFilteringRule
Example:
resource = session.zia.UrlFilteringRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | No | - |
adaptive_access_profiles | AdaptiveAccessProfileWrapperCollection | No | - |
allow_policy_rule_re_order | boolean | No | - |
authentication_levels | IAMAuthenticationLevelWrapperCollection | No | - |
block_override | boolean | No | - |
browser_eun_template_id | integer | No | - |
capture_flag | string | No | - |
capture_PCAP | boolean | No | - |
cbi_profile | BrowserIsolationProfile | No | - |
cbi_profile_id | integer | No | - |
ciparule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
end_user_notification_url | string | No | - |
enforce_time_validity | boolean | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
http_header_action_profiles | EntityReferenceWrapperCollection | No | - |
http_header_profiles | EntityReferenceWrapperCollection | No | - |
icap_server | EntityReference | No | - |
id | integer | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
order | integer | No | - |
override_groups | EntityReferenceWrapperCollection | No | - |
override_users | EntityReferenceWrapperCollection | No | - |
predefined | boolean | No | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | No | - |
rank | integer | No | - |
request_methods | UrlFilteringRuleRequestMethodsEnumCollection | No | - |
size_quota | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule | boolean | No | - |
template_synced_rule_flag | string | No | - |
time_quota | integer | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
url_categories | stringCollection | No | - |
url_categories2 | stringCollection | No | - |
user_agent_types | UserAgentTypesEnumCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
validity_end_time | integer | No | - |
validity_start_time | integer | No | - |
validity_time_zone_id | string | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
Related
- UrlFilteringRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource