pyZscaler SDK - Library Reference#

pyZscaler is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.

Quick Links#

Attention

This SDK is not affiliated with, nor supported by Zscaler in any way.

Overview#

This site is the library reference for the pyZscaler SDK and describes every class and method in detail. If you are looking for user documentation with explanations and examples then you might be looking for the pyZscaler User Documentation

Features#

Simplified authentication with Zscaler APIs.
Uniform interaction with all Zscaler APIs.
Uses python-box to add dot notation access to json data structures.
Zscaler API output automatically converted from CamelCase to Snake Case.
Various quality of life enhancements for object update methods.

Products#

Installation#

The most recent version can be installed from pypi as per below.

$ pip install pyzscaler

Usage#

Before you can interact with any of the Zscaler APIs, you may need to generate API keys or retrieve tenancy information for each product that you are interfacing with. Once you have the requirements and you have installed pyZscaler, you’re ready to go.

Getting started#

Quick ZIA Example#

from pyzscaler import ZIA

zia = ZIA(api_key='API_KEY', cloud='CLOUD', username='USERNAME', password='PASSWORD')
for user in zia.users.list_users():
    print(user)

Quick ZPA Example#

from pyzscaler import ZPA

zpa = ZPA(client_id='CLIENT_ID', client_secret='CLIENT_SECRET', customer_id='CUSTOMER_ID')
for app_segment in zpa.app_segments.list_segments():
    print(app_segment)

Quick ZCC Example#

from pyzscaler import ZCC

zcc = ZCC(client_id='CLIENT_ID', client_secret='CLIENT_SECRET', company_id='COMPANY_ID)
for device in zcc.devices.list_devices():
    print(device)

Quick ZDX Example#

from pyzscaler import ZDX

zdx = ZDX(client_id='CLIENT_ID', client_secret='CLIENT_SECRET')
for device in zdx.devices.list_devices():
    print(device)

Quick ZCON Example#

from pyzscaler import ZCON

zcon = ZCON(api_key='API_KEY', cloud='CLOUD', username='USERNAME', password='PASSWORD')
for group in zcon.connectors.list_groups():
    print(group)

Contributing#

Contributions to pyZscaler are absolutely welcome. At the moment, we could use more tests and documentation/examples. Please see the Contribution Guidelines for more information.

Poetry is currently being used for builds and management. You’ll want to have poetry installed and available in your environment.

Issues#

Please feel free to open an issue using Github Issues if you run into any problems using pyZscaler.

License#

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.