Releases · zscaler/zscaler-sdk-python

06 May 00:19

github-actions

v1.2.0

29183ea

v1.2.0

1.2.0 (May, 5 2025)

Notes

Python Versions: v3.8, v3.9, v3.10, v3.11

ZIA NAT Control Policy

PR #270 - Added the following new ZIA API Endpoints:
- Added GET /dnatRules Retrieves a list of all configured and predefined DNAT Control policies.
- Added GET /dnatRules/{rule_id} Retrieves the DNAT Control policy rule information based on the specified ID
- Added POST /dnatRules Adds a new DNAT Control policy rule.
- Added PUT /dnatRules/{rule_id} Updates the DNAT Control policy rule information based on the specified ID
- Added DELETE /dnatRules/{rule_id} Deletes the DNAT Control policy rule information based on the specified ID

ZIA NSS Servers

PR #270 - Added the following new ZIA API Endpoints:
- Added GET /nssServers Retrieves a list of registered NSS servers.
- Added GET /nssServers/{nss_id} Retrieves the registered NSS server based on the specified ID
- Added POST /nssServers Adds a new NSS server.
- Added PUT /nssServers/{nss_id} Updates an NSS server based on the specified ID
- Added DELETE /nssServers/{nss_id} Deletes an NSS server based on the specified ID

Enhancements

PR #270 - Enhanced exceptions handling for clarity during configuration or API errors.
PR #270 - Enhanced retry mechanism to include 408, 409 status codes.
PR #270 - Improved SDK logging behavior to prevent interference with user-defined loggers. Added example for custom logging setup.

Assets 2

30 Apr 00:07

github-actions

v1.1.0

20f53ac

v1.1.0

1.1.0 (April, 29 2025)

Notes

Python Versions: v3.8, v3.9, v3.10, v3.11

ZIA Password Expiry Settings

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /passwordExpiry/settings Retrieves the password expiration information for all the admins
- Added PUT /passwordExpiry/settings Updates the password expiration information for all the admins.

ZIA Alerts

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /alertSubscriptions Retrieves a list of all alert subscriptions
- Added GET /alertSubscriptions/{subscription_id} Retrieves the alert subscription information based on the specified ID
- Added POST /alertSubscriptions Adds a new alert subscription.
- Added PUT /alertSubscriptions/{subscription_id} Updates an existing alert subscription based on the specified ID

ZIA Bandwidth Classes

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /bandwidthClasses Retrieves a list of bandwidth classes for an organization.
- Added GET /bandwidthClasses/lite Retrieves a list of bandwidth classes for an organization
- Added GET /bandwidthClasses/{class_id} Retrieves the alert subscription information based on the specified ID
- Added POST /bandwidthClasses Adds a new bandwidth class.
- Added PUT /bandwidthClasses/{class_id} Updates a bandwidth class based on the specified ID
- Added DELETE /bandwidthClasses/{class_id} Deletes a bandwidth class based on the specified ID

ZIA Bandwidth Control Rules

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /bandwidthControlRules Retrieves all the rules in the Bandwidth Control policy.
- Added GET /bandwidthControlRules/lite Retrieves all the rules in the Bandwidth Control policy
- Added GET /bandwidthControlRules/{rule_id} Retrieves the Bandwidth Control policy rule based on the specified ID
- Added POST /bandwidthControlRules Adds a new Bandwidth Control policy rule.
- Added PUT /bandwidthControlRules/{rule_id} Updates the Bandwidth Control policy rule based on the specified ID
- Added DELETE /bandwidthControlRules/{rule_id} Deletes a Bandwidth Control policy rule based on the specified ID

ZIA Risk Profiles

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /riskProfiles Retrieves the cloud application risk profile.
- Added GET /riskProfiles/lite Retrieves the cloud application risk profile
- Added GET /riskProfiles/{profile_id} Retrieves the cloud application risk profile based on the specified ID
- Added POST /riskProfiles Adds a new cloud application risk profile.
- Added PUT /riskProfiles/{profile_id} Updates the cloud application risk profile based on the specified ID
- Added DELETE /riskProfiles/{profile_id} Deletes the cloud application risk profile based on the specified ID

ZIA Cloud Application Instances

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /cloudApplicationInstances Retrieves the list of cloud application instances configured in the ZIA Admin Portal.
- Added GET /cloudApplicationInstances/{instance_id} Retrieves information about a cloud application instance based on the specified ID
- Added POST /cloudApplicationInstances Add a new cloud application instance.
- Added PUT /cloudApplicationInstances/{instance_id} Updates information about a cloud application instance based on the specified ID
- Added DELETE /cloudApplicationInstances/{instance_id} Deletes a cloud application instance based on the specified ID

ZIA Tenancy Restriction Profile

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /tenancyRestrictionProfile Retrieves all the restricted tenant profiles.
- Added GET /tenancyRestrictionProfile/{profile_id}Retrieves the restricted tenant profile based on the specified ID
- Added POST /tenancyRestrictionProfile Creates restricted tenant profiles.
- Added PUT /tenancyRestrictionProfile/{profile_id} Updates the restricted tenant profile based on the specified ID
- Added DELETE /tenancyRestrictionProfile/{profile_id} Deletes the restricted tenant profile based on the specified ID

ZIA DNS Gateway

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /dnsGateways Retrieves a list of DNS Gateways.
- Added GET /dnsGateways/lite Retrieves a list of DNS Gateways
- Added GET /dnsGateways/{gateway_id} Retrieves the DNS Gateway based on the specified ID
- Added POST /dnsGateways Adds a new DNS Gateway.
- Added PUT /dnsGateways/{gateway_id} Updates the DNS Gateway based on the specified ID
- Added DELETE /dnsGateways/{gateway_id} Deletes a DNS Gateway based on the specified ID

ZIA Proxies

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /proxies Retrieves a list of all proxies configured for third-party proxy services.
- Added GET /proxies/lite Retrieves a list of all proxies configured for third-party proxy services
- Added GET /proxies/{proxy_id} Retrieves the proxy information based on the specified ID
- Added POST /proxies Adds a new proxy for a third-party proxy service.
- Added PUT /proxies/{proxy_id} Updates an existing proxy based on the specified ID
- Added DELETE /proxies/{proxy_id} Deletes an existing proxy based on the specified ID
- Added DELETE /dedicatedIPGateways/lite Retrieves a list of dedicated IP gateways.

ZIA FTP Settings

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /ftpSettings Retrieves the FTP Control status and the list of URL categories for which FTP is allowed.
- Added PUT /ftpSettings Updates the FTP Control settings.

ZIA Mobile Mobile Protection Policy

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /mobileAdvanceThreatSettings Retrieves all the rules in the Mobile Malware Protection policy
- Added PUT /mobileAdvanceThreatSettings Updates the Mobile Malware Protection rule information.

ZIA System Audit

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /configAudit Retrieves the System Audit Report.
- Added GET /configAudit/ipVisibility Retrieves the IP visibility audit report.
- Added GET /configAudit/pacFile Retrieves the PAC file audit report.
Note: This endpoint is accessible via Zscaler OneAPI only.

ZIA Time Intervals

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /timeIntervals Retrieves the System Audit Report.
- Added GET /timeIntervals/{interval_id} Retrieves the configured time interval based on the specified ID
- Added POST /timeIntervals/{interval_id} Adds a new time interval.
- Added PUT /timeIntervals/{interval_id} Updates the time interval based on the specified ID
- Added DELETE /timeIntervals/{interval_id} Deletes a time interval based on the specified ID

ZIA Data Center Exclusions

PR #267 - Added the following new ZIA API Endpoints:
- Added GET /dcExclusions Retrieves the list of Zscaler data centers (DCs) that are currently excluded from service to your organization based on configured exclusions in the ZIA Admin Portal
- Added POST /dcExclusions/{dc_id} Adds a data center (DC) exclusion to disable the tunnels terminating at a virtual IP address of a Zscaler DC
- Added PUT /dcExclusions/{dc_id} Updates a Zscaler data center (DC) exclusion configuration based on the specified ID.
- Added DELETE /dcExclusions/{dc_id} Deletes a Zscaler data center (DC) exclusion configuration based on the specified ID.
- Added GET /datacenters Retrieves the list of Zscaler data centers (DCs) that can be excluded from service to your organization

Assets 2

22 Apr 23:44

github-actions

v1.0.3

9120648

v1.0.3

1.0.3 (April, 22 2025) - BREAKING CHANGES

Notes

Python Versions: v3.8, v3.9, v3.10, v3.11

Zscaler OneAPI Support

PR #257: Added support for OneAPI Oauth2 authentication support through Zidentity.

NOTES

Starting at v1.0.0 version this SDK provides dual API client functionality and is backwards compatible with the legacy Zscaler API framework.
The new OneAPI framework is compatible only with the following products ZCC/ZIA/ZPA.
The following products ZTW - Cloud Connector and ZDX and Zscaler Digital Experience, authentication methods remain unnaffected.
The package ZCON (Zscaler Cloud and Branch Connector) has been renamed to ZTW
The following products ZWA - Zscaler Workflow Automation authentication methods remain unnaffected.

Refer to the README page for details on client instantiation, and authentication requirements on each individual product.

WARNING: Attention Government customers. OneAPI and Zidentity is not currently supported for the following ZIA clouds: zscalergov and zscalerten or ZPA GOV, and GOVUS. Please refer to the Zscaler Legacy API Framework section in the README for more information on how authenticate to these environments using the built-in Legacy API method.

PR #257: All API clients now support Config Setter object ZCC/ZTW/ZDX/ZIA/ZPA/ZWA

ZCC New Endpoints

PR #261 - Added the following new ZCC API Endpoints:

Added GET /downloadServiceStatus to download service status for all devices.
Added GET /getDeviceCleanupInfo to retrieve device cleanup information.
Added PUT /setDeviceCleanupInfo to cleanup device information.
Added GET /getDeviceDetails to retrieve device detailed information.
Added GET /getAdminUsers to retrieve mobile portal admin user.
Added PUT /editAdminUser to update mobile portal admin user.
Added GET /getAdminUsersSyncInfo to retrieve mobile portal admin user sync information.
Added POST /syncZiaZdxAdminUsers to retrieve mobile portal admin users ZIA and ZDX sync information.
Added POST /syncZpaAdminUsers to retrieve mobile portal admin users ZPA sync information.
Added GET /getAdminRoles to retrieve mobile portal admin roles.
Added GET /getCompanyInfo to retrieve company information.
Added GET /getZdxGroupEntitlements to retrieve ZDX Group entitlement enablement.
Added PUT /updateZdxGroupEntitlement to retrieve ZDX Group entitlement enablement.
Added GET /updateZpaGroupEntitlement to retrieve ZPA Group entitlement enablement.
Added GET /web/policy/listByCompany to retrieve Web Policy By Company ID.
Added PUT /web/policy/activate to activate mobile portal web policy
Added PUT /web/policy/edit to update mobile portal web policy
Added DELETE /web/policy/{policyId}/delete to delete mobile portal web policy.
Added GET /webAppService/listByCompany to retrieve Web App Service information By Company ID.
Added GET /webFailOpenPolicy/listByCompany to retrieve web Fail Open Policy information By Company ID.
Added PUT /webFailOpenPolicy/edit to update mobile portal web Fail Open Policy.
Added GET /webForwardingProfile/listByCompany to retrieve Web Forwarding Profile information By Company ID.
Added POST /webForwardingProfile/edit to create a Web Forwarding Profile.
Added DELETE /webForwardingProfile/{profileId}/delete to delete Web Forwarding Profile.
Added GET /webTrustedNetwork/listByCompany to retrieve multiple Web Trusted Network information By Company ID.
Added POST /webTrustedNetwork/edit to create Web Trusted Network resource.
Added PUT /webTrustedNetwork/edit to update Web Trusted Network resource.
Added DELETE /webTrustedNetwork/{networkId}/delete to delete Web Trusted Network resource.
Added GET /getWebPrivacyInfo to retrieve Web Privacy Info.
Added GET /setWebPrivacyInfo to update Web Privacy Info.

ZIA Sandbox Submission - BREAKING CHANGES

PR #261 - Authentication to Zscaler Sandbox now use the following attributes during client instantiation.

sandboxToken - Can also be sourced from the ZSCALER_SANDBOX_TOKEN environment variable.
sandboxCloud - Can also be sourced from the ZSCALER_SANDBOX_CLOUD environment variable.

NOTE The previous ZIA_SANDBOX_TOKEN has been deprecated.

ZIA Sandbox Rules

PR #261 - Added the following new ZIA API Endpoints:

Added GET /sandboxRules to retrieve the list of all Sandbox policy rules.
Added GET /sandboxRules/{ruleId} to retrieve the Sandbox policy rule information based on the specified ID.
Added POST /sandboxRules to add a Sandbox policy rule.
Added PUT /sandboxRules/{ruleId} to update the Sandbox policy rule configuration for the specified ID.
Added DELETE /sandboxRules/{ruleId} to delete the Sandbox policy rule based on the specified ID.

ZIA DNS Control Rules

PR #261 - Added the following new ZIA API Endpoints:

Added GET /firewallDnsRules to retrieve the list of all DNS Control policy rules.
Added GET /firewallDnsRules/{ruleId} to retrieve the DNS Control policy rule information based on the specified ID.
Added POST /firewallDnsRules to add a DNS Control policy rules.
Added PUT /firewallDnsRules/{ruleId} to update the DNS Control policy rule configuration for the specified ID.
Added DELETE /firewallDnsRules/{ruleId} to delete the DNS Control policy rule based on the specified ID.

ZIA IPS Control Rules

PR #261 - Added the following new ZIA API Endpoints:

Added GET /firewallIpsRules to retrieve the list of all IPS Control policy rules.
Added GET /firewallIpsRules/{ruleId} to retrieve the IPS Control policy rule information based on the specified ID.
Added POST /firewallIpsRules to add a IPS Control policy rule.
Added PUT /firewallIpsRules/{ruleId} to update the IPS Control policy rule configuration for the specified ID.
Added DELETE /firewallIpsRules/{ruleId} to delete the IPS Control policy rule based on the specified ID.

ZIA File Type Control Policy

PR #261 - Added the following new ZIA API Endpoints:

Added GET /fileTypeRules to retrieve the list of all File Type Control policy rules.
Added GET /fileTypeRules/lite to retrieve the list of all File Type Control policy rules.
Added GET /fileTypeRules/{ruleId} to retrieve the File Type Control policy rule information based on the specified ID.
Added POST /fileTypeRules to add a File Type Control policy rule.
Added PUT /fileTypeRules/{ruleId} to update the File Type Control policy rule configuration for the specified ID.
Added DELETE /fileTypeRules/{ruleId} to delete the File Type Control policy rule based on the specified ID.

ZIA Forwarding Control Policy - Proxy Gateways

PR #261 - Added the following new ZIA API Endpoints:

Added GET /proxyGateways to retrieve the proxy gateway information.
Added GET /proxyGateways/lite to retrieve the name and ID of the proxy.

ZIA Cloud Nanolog Streaming Service (NSS)

PR #261 - Added the following new ZIA API Endpoints:

Added GET /nssFeeds to retrieve the cloud NSS feeds.
Added GET /nssFeeds/{feedId} to retrieve information about cloud NSS feed based on the specified ID.
Added POST /nssFeeds to add a new cloud NSS feed.
Added PUT /nssFeeds/{feedId} to update cloud NSS feed configuration based on the specified ID.
Added DELETE /nssFeeds/{feedId} to delete cloud NSS feed configuration based on the specified ID.
Added GET /nssFeeds/feedOutputDefaults to retrieve the default cloud NSS feed output format for different log types.
Added GET /nssFeeds/testConnectivity/{feedId} to test the connectivity of cloud NSS feed based on the specified ID
Added POST /nssFeeds/validateFeedFormat to validates the cloud NSS feed format and returns the validation result

ZIA Advanced Threat Protection Policy

PR #261 - Added the following new ZIA API Endpoints:

Added GET /cyberThreatProtection/advancedThreatSettings to retrieve the advanced threat configuration settings.
Added PUT /cyberThreatProtection/advancedThreatSettings to update the advanced threat configuration settings.
Added GET /cyberThreatProtection/maliciousUrls to retrieve the malicious URLs added to the denylist in the Advanced Threat Protection (ATP) policy
Added PUT /cyberThreatProtection/maliciousUrls to updates the malicious URLs added to the denylist in ATP policy
Added GET /cyberThreatProtection/securityExceptions to retrieves information about the security exceptions configured for the ATP policy
Added PUT /cyberThreatProtection/securityExceptions to update security exceptions for the ATP policy

ZIA Advanced Threat Protection Policy

PR #261 - Added the following new ZIA API Endpoints:

Added `GET /cyberThreatPro...

Assets 2

22 Apr 23:04

github-actions

v1.0.2

4cb6fb6

v1.0.2

1.0.2 (April, 22 2025) - BREAKING CHANGES

Notes

Python Versions: v3.8, v3.9, v3.10, v3.11

Zscaler OneAPI Support

PR #257: Added support for OneAPI Oauth2 authentication support through Zidentity.

NOTES

Starting at v1.0.0 version this SDK provides dual API client functionality and is backwards compatible with the legacy Zscaler API framework.
The new OneAPI framework is compatible only with the following products ZCC/ZIA/ZPA.
The following products ZTW - Cloud Connector and ZDX and Zscaler Digital Experience, authentication methods remain unnaffected.
The package ZCON (Zscaler Cloud and Branch Connector) has been renamed to ZTW
The following products ZWA - Zscaler Workflow Automation authentication methods remain unnaffected.

Refer to the README page for details on client instantiation, and authentication requirements on each individual product.

PR #257: All API clients now support Config Setter object ZCC/ZTW/ZDX/ZIA/ZPA/ZWA

ZCC New Endpoints

PR #260 - Added the following new ZCC API Endpoints:

Added GET /downloadServiceStatus to download service status for all devices.
Added GET /getDeviceCleanupInfo to retrieve device cleanup information.
Added PUT /setDeviceCleanupInfo to cleanup device information.
Added GET /getDeviceDetails to retrieve device detailed information.
Added GET /getAdminUsers to retrieve mobile portal admin user.
Added PUT /editAdminUser to update mobile portal admin user.
Added GET /getAdminUsersSyncInfo to retrieve mobile portal admin user sync information.
Added POST /syncZiaZdxAdminUsers to retrieve mobile portal admin users ZIA and ZDX sync information.
Added POST /syncZpaAdminUsers to retrieve mobile portal admin users ZPA sync information.
Added GET /getAdminRoles to retrieve mobile portal admin roles.
Added GET /getCompanyInfo to retrieve company information.
Added GET /getZdxGroupEntitlements to retrieve ZDX Group entitlement enablement.
Added PUT /updateZdxGroupEntitlement to retrieve ZDX Group entitlement enablement.
Added GET /updateZpaGroupEntitlement to retrieve ZPA Group entitlement enablement.
Added GET /web/policy/listByCompany to retrieve Web Policy By Company ID.
Added PUT /web/policy/activate to activate mobile portal web policy
Added PUT /web/policy/edit to update mobile portal web policy
Added DELETE /web/policy/{policyId}/delete to delete mobile portal web policy.
Added GET /webAppService/listByCompany to retrieve Web App Service information By Company ID.
Added GET /webFailOpenPolicy/listByCompany to retrieve web Fail Open Policy information By Company ID.
Added PUT /webFailOpenPolicy/edit to update mobile portal web Fail Open Policy.
Added GET /webForwardingProfile/listByCompany to retrieve Web Forwarding Profile information By Company ID.
Added POST /webForwardingProfile/edit to create a Web Forwarding Profile.
Added DELETE /webForwardingProfile/{profileId}/delete to delete Web Forwarding Profile.
Added GET /webTrustedNetwork/listByCompany to retrieve multiple Web Trusted Network information By Company ID.
Added POST /webTrustedNetwork/edit to create Web Trusted Network resource.
Added PUT /webTrustedNetwork/edit to update Web Trusted Network resource.
Added DELETE /webTrustedNetwork/{networkId}/delete to delete Web Trusted Network resource.
Added GET /getWebPrivacyInfo to retrieve Web Privacy Info.
Added GET /setWebPrivacyInfo to update Web Privacy Info.

ZIA Sandbox Submission - BREAKING CHANGES

PR #260 - Authentication to Zscaler Sandbox now use the following attributes during client instantiation.

sandboxToken - Can also be sourced from the ZSCALER_SANDBOX_TOKEN environment variable.
sandboxCloud - Can also be sourced from the ZSCALER_SANDBOX_CLOUD environment variable.

NOTE The previous ZIA_SANDBOX_TOKEN has been deprecated.