Skip to main content

Configuring the Postman REST API Client

Zscaler offers a Postman collection that simplifies interaction with its API endpoints, allowing you to easily test and manage API requests within the Postman application. This collection is designed to work seamlessly with all APIs included in OneAPI, requiring minimal configurations from the user. It includes preconfigured request scripts for authentication, along with prebuilt payloads and parameters where necessary. Additionally, the collection includes all the essential preset variables, ensuring a smooth experience. This article provides information on how to set up your Postman application and make API requests, along with a link to download the Postman collection for OneAPI.

NOTE
  • You can use the Postman collection provided by Zscaler on Windows, Linux, and macOS versions of the Postman REST API client.
  • Before getting started, ensure that you have obtained the API client information, such as client ID and client secret, from Authentication Service. This article follows the client secret flow of authentication which is supported by the Postman application.

To learn more about rate limiting and HTTP status codes, see Understanding Rate Limiting and Understanding Response Codes & Error Messages. If you encounter any issues with the API, contact Zscaler Support.

Installing and Configuring Postman for Windows, macOS, or Linux​

To install the Postman application:

  1. Go to the Download Postman page and download the application for your OS (i.e., Windows, macOS, or Linux).

    NOTE

    For this example, the Postman application for 64-bit version Windows is used to illustrate the instructions.

  2. Open the downloaded Postman setup file to install the application. After installation, the login window for signing in to Postman appears.

  3. In the login window, create an account, and sign in using your account. If you already have a Postman account, log in to Postman with your existing credentials.