Understanding OneAPI

OneAPI provides programmatic access to different Zscaler services with consistency in API design and experience across all products, reliability, and high performance of the APIs. OneAPI allows for a centralized management of key components and features of APIs, including but not limited to API authentication, tenant access policies and management, rate limiting, caching, API lifecycle management, etc., thereby providing a consistent and uniform cross-product API experience and offering enhanced support for automation and integration with external services.

Before using the APIs, Zscaler recommends reviewing Getting Started for information regarding prerequisites, authentication, and how to make API calls. This API Reference contains detailed information on all available API calls, endpoints, and parameters. For a summary of the rate limits used by the endpoints, see Understanding Rate Limiting. To try out requests and responses for API calls using the Postman application, see Configuring the Postman REST API Client.

Zscaler can make periodic updates to the request and response parameters used by OneAPI endpoints. If you encounter any issues with using the API endpoints, contact Zscaler Support.