BranchConnectors Collection

Iterate over BranchConnector resources in Zscaler Private Access V1.

Returned items are BranchConnector resources — access their fields via dot notation.

Iterate all items

import zssdk
session = zssdk.Session(profile_name="beta")

# Yield each item; pagination (if any) is handled automatically
for item in session.zpa.branch_connectors.all():
    print(item.id)

# Materialize the full list
all_items = list(session.zpa.branch_connectors.all())
print(f"Total items: {len(all_items)}")

Iterate by page

# Paginated collections yield each server page; simple collections yield one page
for page in session.zpa.branch_connectors().pages():
    print(f"Got a page with {len(page)} items")
    for item in page:
        print(item.id)

Server-side pagination

This collection paginates server-side via the GetBranchConnectors operation.

Pagination token	Value
Style	page
Input token	page
Output token	totalPages
Limit key	pagesize
Result key	list

# Tune the per-request batch size and cap total yielded items
for item in session.zpa.branch_connectors.page_size(50).limit(100):
    print(item.id)

See the Pagination guide for the full pagination model.

Filter and search

# Server-side filtering (query params sent to the API)
for item in session.zpa.branch_connectors.filter(search="value"):
    print(item.id)

# Client-side JMESPath on each page
for item in session.zpa.branch_connectors.search("[?contains(name, 'prod')]"):
    print(item.id)

Resource Type

Each item is a BranchConnector instance with standard CRUDL and any custom actions defined on that resource.

Related

• Pagination guide