DnsRule
Dns Rule resource for Zscaler Cloud & Branch Connector.
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 DnsRule
logging.getLogger('zssdk.ztw').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 DnsRule
resource = session.ztw.DnsRule(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 DnsRule. 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 | - |
block_response_code | string | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
order | integer | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | 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 | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Returns: DnsRule
Example:
resource = session.ztw.DnsRule()
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")
create_forwarding_rule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
block_response_code | string | No | - |
dedicated_IP_gateway | EntityReference | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
dest_workload_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
forward_method | string | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
proxy_gateway | EntityReference | No | - |
rank | integer | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
src_workload_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
type | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
wan_selection | string | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
zpa_application_segment_groups | ZpaApplicationSegmentGroupWrapperCollection | No | - |
zpa_application_segments | ZpaApplicationSegmentWrapperCollection | No | - |
zpa_broker_rule | boolean | No | - |
zpa_gateway | EntityReference | No | - |
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule()
result = resource.create_forwarding_rule(name="example-name")
print(result)
create_self_rule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
block_response_code | string | No | - |
dedicated_IP_gateway | EntityReference | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
dest_workload_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
forward_method | string | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
proxy_gateway | EntityReference | No | - |
rank | integer | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
src_workload_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
type | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
wan_selection | string | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
zpa_application_segment_groups | ZpaApplicationSegmentGroupWrapperCollection | No | - |
zpa_application_segments | ZpaApplicationSegmentWrapperCollection | No | - |
zpa_broker_rule | boolean | No | - |
zpa_gateway | EntityReference | No | - |
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule()
result = resource.create_self_rule(name="example-name")
print(result)
delete()
Deletes a DnsRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
resource.delete()
get_ec_dns_rules_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
predefined_rule_count | boolean | No | - |
rule_name | string | No | - |
rule_order | string | No | - |
rule_description | string | No | - |
rule_action | string | No | - |
location | string | No | - |
Example:
resource = session.ztw.DnsRule()
result = resource.get_ec_dns_rules_count()
print(result)
get_forwarding_rules_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
predefined_rule_count | boolean | No | - |
rule_name | string | No | - |
rule_order | string | No | - |
rule_description | string | No | - |
rule_forward_method | string | No | - |
location | string | No | - |
Example:
resource = session.ztw.DnsRule()
result = resource.get_forwarding_rules_count()
print(result)
get_self_ec_rules_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
predefined_rule_count | boolean | No | - |
rule_name | string | No | - |
rule_order | string | No | - |
rule_description | string | No | - |
location | string | No | - |
rule_forward_method | string | No | - |
Example:
resource = session.ztw.DnsRule()
result = resource.get_self_ec_rules_count()
print(result)
load()
Fetches an existing DnsRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: DnsRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing DnsRule. 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 | - |
block_response_code | string | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
order | integer | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | 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 | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Returns: DnsRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
get_forwarding_rule_by_id()
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.get_forwarding_rule_by_id()
print(result)
update_forwarding_rule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
block_response_code | string | No | - |
dedicated_IP_gateway | EntityReference | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
dest_workload_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
forward_method | string | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
proxy_gateway | EntityReference | No | - |
rank | integer | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
src_workload_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
type | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
wan_selection | string | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
zpa_application_segment_groups | ZpaApplicationSegmentGroupWrapperCollection | No | - |
zpa_application_segments | ZpaApplicationSegmentWrapperCollection | No | - |
zpa_broker_rule | boolean | No | - |
zpa_gateway | EntityReference | No | - |
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.update_forwarding_rule(name="example-name")
print(result)
delete_forwarding_rule()
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.delete_forwarding_rule()
print(result)
get_ec_self_rule_by_id()
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.get_ec_self_rule_by_id()
print(result)
update_self_rule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
app_service_groups | EntityReferenceWrapperCollection | No | - |
block_response_code | string | No | - |
dedicated_IP_gateway | EntityReference | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
dest_workload_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
forward_method | string | No | - |
groups | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
nw_application_groups | EntityReferenceWrapperCollection | No | - |
nw_applications | NwApplicationsEnumCollection | No | - |
nw_service_groups | EntityReferenceWrapperCollection | No | - |
nw_services | EntityReferenceWrapperCollection | No | - |
order | integer | No | - |
proxy_gateway | EntityReference | No | - |
rank | integer | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
src_workload_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
type | string | No | - |
users | EntityReferenceWrapperCollection | No | - |
wan_selection | string | No | - |
zpa_app_segments | AppSegmentWrapperCollection | No | - |
zpa_application_segment_groups | ZpaApplicationSegmentGroupWrapperCollection | No | - |
zpa_application_segments | ZpaApplicationSegmentWrapperCollection | No | - |
zpa_broker_rule | boolean | No | - |
zpa_gateway | EntityReference | No | - |
Returns: ForwardingRule
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.update_self_rule(name="example-name")
print(result)
delete_self_forwarding_rule()
Example:
resource = session.ztw.DnsRule(id="your-resource-id")
result = resource.delete_self_forwarding_rule()
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | No | - |
block_response_code | string | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | EndPointApplicationThreatLevelsEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | 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 | Yes | - |
order | integer | No | - |
predefined | boolean | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
source_ip_group_exclusion | boolean | No | - |
source_ip_group_exclusion_flag | boolean | 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 | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Related
- DnsRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource