Cato Networks Knowledge Base

Generating API Keys for the Cato API

  • Updated

Overview of Cato API Keys

The API Keys Management screen lets you generate API keys in the Cato Management Application that are used to authenticate to the Cato API server. Enter this API key when you configure an API client (such as Postman or Altair) to run API calls.

Make sure that you copy the API key from the pop-up window. Once you close the pop-up window, you can't access the key again.

Managing API Keys

The API Keys Management screen shows you the API keys for your account. You can use this screen to generate and revoke API keys. The Name for the API key is only used to identify each key and isn't used as part of the authentication process.

APIManagement.png

Generating an API Key

Generate the key for the Cato API and then paste it in the API client.

To generate an API key:

  1. In the navigation menu, click Administration > API Management.

  2. On the API Keys tab, click New. The Create API Key panel opens.

  3. Enter a Name for the key and then click Apply. The API key is added and a popup window containing the new API key is displayed.

  4. Click copy.png (Copy) and copy the API Key that is generated by the Cato Management Application and save it to a secure location.

    Once you close this window, you can't access the value for the API key.

  5. Click OK to close the pop-up window.

Revoking an API Key

You can revoke the API key. This means removing it from the Cato Management Application. Once revoked, the key can't be used to authenticate to the API server.

To revoke an API key:

  1. In the navigation menu, click Administration > API Management.

  2. In the row with the API key, click Delete.png (Delete).

  3. In the confirmation window, click Delete. The API key is revoked and removed.

Was this article helpful?

2 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.