/zscaler-python-sdk

Python interface for Zscaler Internet Access

Primary LanguagePythonMIT LicenseMIT

Zscaler Python SDK

This is a Python SDK for Zscaler Internet Access. This client library is designed to support the Zscaler Internet Access (ZIA) API and SD-WAN API (aka "Partner API"). All API referecnes can be found here [LINK]. PLEASE READ THE DOCUMENTATION BEFORE CONTACTING ZSCALER

This SDK has been developed mainly using Python 3.5.x on Mac OSX 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.]

Quick Start

  1. If you have not verified your credentials, we suggest starting [HERE], unless you are already familar with this API.

  2. Set Environment Variables

export ZIA_USERNAME="<ZIA-ADMIN-USER-ID>"
export ZIA_PASSWORD="<ZIA-ADMIN-USER-PASSWORD>"
export ZIA_API="<ZIA-API-KEY>" 

export PARTNER_USERNAME="<ZIA-PARTNER-ADMIN-USER-ID>"
export PARTNER_PASSWORD="<ZIA-PARTNER-ADMIN-USER-PASSWORD>"
export PARTNER_API="<PARTNER-API-KEY>"
  1. Clone Repository (OS must have git installed)
$ git clone https://github.com/eparra/zscaler-python-sdk.git
$ cd zscaler-python-sdk/
  1. Install SDK requirements
$ pip3 install -r requirements.txt
...
  1. Install SDK
$ python3 setup.py install
...
  1. Check out examples
$ ls examples/
...

API Support

ZIA API

Supported

  • Security Policy Settings
  • Activate

Future

  • Admin Audit Logs
  • User Management
  • SSL Inspection Settings
  • URL Categories
  • Sandbox Report

SD-WAN (Partner) API

  • VPN Credentials
  • Locations
  • Activate

Licensing

This work is released under the MIT license. A copy of the license is provided in the LICENSE file.

Reporting Issues

If you have bugs or other issues specifically pertaining to this library, file them here.

References