Managing the Organization API Key


Managing the Organization API Key

After your API subscription is enabled, your organization's API key is initially provisioned by Zscaler, enabled, and displayed within the API Key Management page along with the base URI. From this page, you can perform the following tasks:

Your API key can be disabled by Zscaler or your service provider. The key might be disabled if your organization exceeds the threshold number of API calls allowed or the code developed for your organization violates Zscaler's terms and conditions.

If this occurs, the ability to add, regenerate, or delete the key is removed and a Disabled status appears.
See image.

You must contact Zscaler Support or your service provider in order to re-enable the key. 

If your cloud service API subscription expires, you will still have access to the API Key Management page but you will not be able to make any modifications. Also, your existing API key will still be valid but disabled. It will be re-enabled after your subscription is renewed. If this occurs, contact Zscaler Support.

API Key Management - Disabled Organization API Key

Your organization can only have one key. You must delete the existing key before you can add a new key.

To add a new organization API key:

  1. Go to Administration > API Key Management.
  2. In the Organization API Key tab, make sure that you have deleted the existing key. Once the key is removed, the Add API Key option becomes available.
  3. Click Add API Key.


The new API key is immediately valid and displayed in the Organization API Key tab.

Once an API key is edited, the action cannot be undone.

To edit the organization API key:

  1. Go to Administration > API Key Management.
  2. In the Organization API Key tab, click the Edit icon.


The Edit API Key window appears.

  1. In the Edit API Key window, enter the New API Key. The new key must meet the following requirements:
    • The new key must be alphanumeric (A-Z, a-z, 0-9) and exactly 12 characters in length
    • The new key cannot be the same as the Current API Key


Edit API Key

  1. Click Confirm.


After confirmation, the old API key is immediately invalidated.

Once an API key is regenerated, the action cannot be undone.

To regenerate the organization API key:

  1. Go to Administration > API Key Management.
  2. In the Organization API Key tab, click the Regenerate icon.
  3. In the confirmation window that appears, click Ok.


After confirmation, a random key string is immediately generated and the old string is invalidated.

Once an API key is deleted, the action cannot be undone.

To delete the organization API key:

  1. Go to Administration > API Key Management.
  2. In the Organization API Key tab, click the Delete icon.
  3. In the confirmation window that appears, click Ok.


After confirmation, the key is immediately removed and invalidated.