Zscaler supports the Windows, macOS, and Linux versions of the Postman REST API app. To learn more about the app and its features, refer to the Postman documentation.

Installing and Configuring Postman for Windows, macOS, or Linux

To install and configure Postman:

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

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

2. Install the app.
3. After installation, open the app and log in using your account.
4. Download the latest version of the cloud service API collection file from the Reference Guide.
5. From the main window, click Import.

See image.

Alternatively, go to the application menu on the top-left corner and click File > Import....

See image.

6. In the Import window that appears, select your .postman_collection file or drag the file to the selection area.

See image.

After the file is imported, a new folder with the name used within the Postman collection file (e.g., cloud service API) is displayed within Collections.

7. Ensure that No Environment is selected in the environment drop-down menu on the top right, and then click the Environment quick look icon.
8. Click Add.

See image.

9. On the New Environment tab that appears, complete the following steps:
   1. Enter a descriptive name for the environment (e.g., Zscaler Test Environment).
   2. Under Variable, enter url.
   3. For Type, leave as default.
   4. For Initial Value, enter https://zsapi.<Zscaler Cloud Name>/api/v1, where <Zscaler Cloud Name> is the cloud name provisioned for your organization by Zscaler (e.g., zsapi.zscalerbeta.net). To learn more, see What Is My Cloud Name for ZIA?
   5. Click Save and close the tab.

See image.

Select the environment you configured (e.g., Zscaler Test Environment) from the environment drop-down menu on the top right. To learn more, refer to the Postman documentation.

See image.

Authenticating a Session in Postman

After installing and configuring the Postman app, authenticate a session.

1. Log in to the ZIA Admin Portal using your API admin credentials. To learn more, see Getting Started.
2. Go to Administration > Cloud Service API Security > Cloud Service API Key.
3. On the Cloud Service API Key tab, copy the Key.
4. In the Postman app:
   1. Click the Settings icon on the top right, and then choose Settings.

See image.

Alternatively, go to the application menu on the top-left corner and click File > Settings.

See image.

2. Under the General tab, turn off SSL certificate verification.

See image.

3. In the Postman collection you imported previously, select the POST Authenticate request.

See image.

4. Go to the Pre-request Script tab and replace YourApiKey in the script with the Key you copied in step 3.

See image.

5. Go to the request's Body tab and replace the username and password with your API admin credentials.

See image.

6. Click Send.

If authentication is successful, a Status 200 OK message is returned, for example:

See image.

Making an API Call in Postman

Make an API call using Postman. The following example shows how to look up categories for a specified list of URLs using /urlLookup:

1. Make sure that you can authenticate successfully.
2. Go to URL categories > POST URL lookup.

Click the request's Body tab to view the list of reconfigured URLs for which the lookup operation must be performed. You can look up a maximum of 100 URLs per request, with each URL not exceeding 1024 characters.

3. Click Send.

If the request is successful, you should receive a Status 200 OK message and a response Body that looks as follows:

See image.

You can see the JSESSIONID under the Cookies tab.

See image.

By default, the session is terminated after 30 minutes and reauthentication is required. However, the time interval can be changed, from 5 minutes to 600 minutes (10 hours), within the ZIA Admin Portal. To learn more, see Configuring Advanced Settings.