DnsGateway

Dns Gateway 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 DnsGateway
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 DnsGateway
resource = session.zia.DnsGateway(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 DnsGateway. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
auto_created	boolean	No	-
dns_gateway_protocols	DnsGatewayProtocolsEnumCollection	No	-
dns_gateway_type	string	No	-
failure_behavior	string	No	-
id	integer	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
name	string	No	-
nat_ztr_gateway	boolean	No	-
primary_ip_or_fqdn	string	No	-
primary_ports	int32Collection	No	-
protocols	DnsGatewayProtocolsEnumCollection	No	-
secondary_ip_or_fqdn	string	No	-
secondary_ports	int32Collection	No	-

Returns: DnsGateway

Example:

resource = session.zia.DnsGateway()
resource.auto_created = True
resource.dns_gateway_protocols = ["value"]
resource.dns_gateway_type = "value"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a DnsGateway by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zia.DnsGateway(id="your-resource-id")
resource.delete()

load()

Fetches an existing DnsGateway by id. Only the id identifier is required; load() takes no other arguments.

Returns: DnsGateway

Example:

resource = session.zia.DnsGateway(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing DnsGateway. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
auto_created	boolean	No	-
dns_gateway_protocols	DnsGatewayProtocolsEnumCollection	No	-
dns_gateway_type	string	No	-
failure_behavior	string	No	-
id	integer	Yes	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
name	string	No	-
nat_ztr_gateway	boolean	No	-
primary_ip_or_fqdn	string	No	-
primary_ports	int32Collection	No	-
protocols	DnsGatewayProtocolsEnumCollection	No	-
secondary_ip_or_fqdn	string	No	-
secondary_ports	int32Collection	No	-

Returns: DnsGateway

Example:

resource = session.zia.DnsGateway(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
auto_created	boolean	No	-
dns_gateway_protocols	DnsGatewayProtocolsEnumCollection	No	-
dns_gateway_type	string	No	-
failure_behavior	string	No	-
id	integer	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
name	string	No	-
nat_ztr_gateway	boolean	No	-
primary_ip_or_fqdn	string	No	-
primary_ports	int32Collection	No	-
protocols	DnsGatewayProtocolsEnumCollection	No	-
secondary_ip_or_fqdn	string	No	-
secondary_ports	int32Collection	No	-

Related

• DnsGateway - Data structure definition
• Logging guide - enable verbose logs while debugging this resource