TrafficCaptureRule
Traffic Capture 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. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.
Quick Start
import zssdk
import logging
# Enable debug logging for TrafficCaptureRule
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 TrafficCaptureRule
resource = session.zia.TrafficCaptureRule(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 TrafficCaptureRule. 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 | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
capture_PCAP | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | No | - |
internal_dest_FQDNs | stringCollection | No | - |
internal_dest_ips | stringCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
pcap_action | boolean | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
txn_sampling | string | No | - |
txn_size_limit | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
Returns: TrafficCaptureRule
Example:
resource = session.zia.TrafficCaptureRule()
resource.access_control = "value"
resource.action = "value"
resource.app_service_groups = [{"association_time": 3600, "deleted": True, "extensions": {"key1": "value", "key2": "value"}, "external_id": "resource-id"}]
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a TrafficCaptureRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.TrafficCaptureRule(id="your-resource-id")
resource.delete()
get_traffic_capture_rule_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
rule_name | string | No | - |
rule_label | string | No | - |
rule_label_id | integer | No | - |
rule_order | string | No | - |
rule_description | string | No | - |
rule_action | string | No | - |
location | string | No | - |
department | string | No | - |
group | string | No | - |
user | string | No | - |
device | string | No | - |
device_group | string | No | - |
device_trust_level | string | No | - |
Example:
resource = session.zia.TrafficCaptureRule()
result = resource.get_traffic_capture_rule_count()
print(result)
get_traffic_capture_rule_order_info()
Returns: TrafficCaptureRuleOrderInfo
Example:
resource = session.zia.TrafficCaptureRule()
result = resource.get_traffic_capture_rule_order_info()
print(result)
load()
Fetches an existing TrafficCaptureRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: TrafficCaptureRule
Example:
resource = session.zia.TrafficCaptureRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing TrafficCaptureRule. 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 | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
capture_PCAP | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | Yes | - |
internal_dest_FQDNs | stringCollection | No | - |
internal_dest_ips | stringCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
pcap_action | boolean | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
txn_sampling | string | No | - |
txn_size_limit | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
Returns: TrafficCaptureRule
Example:
resource = session.zia.TrafficCaptureRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | No | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
capture_PCAP | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
exclude_src_countries | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | No | - |
internal_dest_FQDNs | stringCollection | No | - |
internal_dest_ips | stringCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | No | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
pcap_action | boolean | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
txn_sampling | string | No | - |
txn_size_limit | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
workload_groups | WorkloadGroupWrapperCollection | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
Related
- TrafficCaptureRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource