Cloud & Branch Connector SDK

This article outlines the Zscaler Python SDK resources you can use to manage Cloud & Branch Connector features programmatically, with code examples.

Quick Start

import zssdk

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Access Cloud & Branch Connector service
ztw = session.ztw

Available Resources

Access individual resources using the has pattern:

Resource	Description
AwsAccountGroup	Aws Account Group resource
AdminRole	Admin Role resource
AdminUser	Admin User resource
ApplianceInfo	Appliance Info resource
SessionInfo	Session Info resource
CcaTemplate	Cca Template resource
ActivationStatus	Activation Status resource
Image	Image resource
EcGroup	Ec Group resource
DnsRule	Dns Rule resource
EcGateway	Ec Gateway resource
IpDestinationGroup	Ip Destination Group resource
IpGroup	Ip Group resource
IpSourceGroup	Ip Source Group resource
EcLocation	Ec Location resource
...	11 more resources

Collections

List resources using the hasMany pattern:

Collection	Resource Type
account_groups_lite	EntityResponse
aws_account_groups	AwsAccountGroup
role_summaries_lite	AdminRole
admin_roles	AdminRole
admin_users	AdminUser
appliance_infos	ApplianceInfo
cca_templates	CcaTemplate
images	Image
ec_groups_lite	EcGroup
groups_summaries	EcGroup
ec_groups	EcGroup
instances_lite	EntityReference
forwarding_rules	ForwardingRule
self_ec_rules	ForwardingRule
dns_rules	DnsRule

Example: CRUD Operations

import zssdk

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Create
resource = session.ztw.AwsAccountGroup()
resource.name = "value"
resource.create()

# Read
resource = session.ztw.AwsAccountGroup(id=resource.id)
resource.load()
print(resource.name)

# Update
resource.name = "Updated value"
resource.update()

# Delete
resource.delete()

Example: List Resources

# List all resources
for item in session.ztw.account_groups_lite():
    print(f"{item.id}: {item.name}")