This is a Python SDK for Zscaler Internet Access (ZIA). This client library is designed to support the ZIA API and ZIA Partner API (aka "SD-WAN" API) in ZIA 6.1 or newer. All ZIA API references can be found here [LINK]. PLEASE READ THE DOCUMENTATION BEFORE CONTACTING ZSCALER
This SDK has been developed mainly using Python 3.8.2 on macOS (10.15.7) and Ubuntu 18.04.1 LTS (Bionic Beaver).
NOTE: This repository will experience frequent updates. To minimize breakage, public method names will not change. If you run into any defects, please open issues [HERE.]
-
If you have not verified your credentials, we suggest starting [HERE], unless you are already familar with this API.
-
Set Environment Variables
$ <text-editor> ~/.bash_profile
export ZIA_USERNAME="<ZIA-ADMIN-USER-ID>"
export ZIA_PASSWORD="<ZIA-ADMIN-USER-PASSWORD>"
export ZIA_API="<ZIA-API-KEY>"
export ZIA_PARTNER_USERNAME="<ZIA-PARTNER-ADMIN-USER-ID>"
export ZIA_PARTNER_PASSWORD="<ZIA-PARTNER-ADMIN-USER-PASSWORD>"
export ZIA_PARTNER_API="<ZIA-PARTNER-API-KEY>"
- Setup Virtual Environment (optional)
python3 -m venv zscaler-sdk
cd zscaler-sdk
source bin/activate
- Clone Repository (OS must have git installed)
$ git clone https://github.com/eparra/zscaler-python-sdk.git
$ cd zscaler-python-sdk/
- Install SDK requirements
$ pip3 install -r requirements.txt
...
- Install SDK
$ python3 setup.py install
...
- Check out examples
$ ls examples/
...
- Locations
- VPN Credentials
- Static IP
- GRE Tunnels
This work is released under the MIT license. A copy of the license is provided in the LICENSE file.
If you have bugs or other issues specifically pertaining to this library, file them here.
- https://help.zscaler.com/zia/zia-api
- https://help.zscaler.com/zia/zia-api/api-developer-reference-guide
- https://help.zscaler.com/zia/sd-wan-api-integration
Thanks to: