Managing REST API Tokens on Zenconsole
The REST API settings in Zenconsole allow you to generate and configure API tokens for programmatic access to Zenarmor services.
API tokens can be used to authenticate requests from external applications, automation tools, and other integrations.
To access the REST API settings on Zenconsole, follow these steps:
- Log in to Zenconsole.
- Select the organization you want to manage.
- Navigate to Settings → Organization Settings → REST API.
- The Zenarmor REST API page opens.
If no API tokens have been generated, the following message is displayed: There are no API tokens generated for this organization yet.
Figure 1. REST API Settings on Zenconsole
Generating an API Token
You can generate an API token to enable programmatic access to Zenarmor services.
To generate an API token, follow these steps:
-
Navigate to Settings → Organization Settings → REST API.
-
Click the + Generate API Token button.
-
The Generate API Token window appears.
-
Configure the following fields:
- Name: Enter a descriptive name to identify the API token.
- Scope: Select the permissions to assign to the token:
- Read: Allows access to supported operations that retrieve information.
- Write: Allows access to supported operations that modify data or configuration.
- Allowed IPs: Specify the IP addresses permitted to use the token. Separate multiple IP addresses with commas, such as
192.168.1.1, 10.0.0.1. - Rate Limit: Enter the maximum number of API requests permitted per minute.
-
Review the token configuration.
-
Click Generate to create the API token.
To close the window without creating a token, click Cancel.
Figure 2. Generate API Token Window on Zenconsole
Assign only the permissions required for the intended integration. If an application only needs to retrieve information, use the Read permission.
Keep API tokens secure and avoid sharing them with unauthorized users or exposing them in publicly accessible source code.
Managing Existing API Tokens
Zenconsole allows you to view and manage existing API tokens from the REST API settings page.
Each generated API token is displayed in the token list with the following information:
- Name: The name assigned to the API token.
- Token Identifier: A masked token value displayed with its last few characters to help identify the token without exposing its full value.
- Created: The date when the API token was generated.
- Expires: The date when the API token is scheduled to expire.
- Last Used: The date when the token was last used. Tokens that have not yet been used display Never used.
Each token also provides Edit and Revoke actions for managing its name and access.
Editing an API Token
Zenconsole allows you to rename an existing API token using the Edit action.
To edit an API token, follow these steps:
- Navigate to Settings → Organization Settings → REST API.
- Locate the API token you want to rename.
- Click Edit next to the corresponding token.
- The token's editable Name field appears directly below its information.
- Enter the new name in the Name field.
- Click Save to apply the change.
To discard your changes, click Cancel.
Revoking an API Token
You can revoke an API token when it is no longer needed or when you want to prevent further access using that token.
To revoke an API token, follow these steps:
- Navigate to Settings → Organization Settings → REST API.
- Locate the API token you want to revoke.
- Click Revoke next to the corresponding token.
- A Warning confirmation window appears, displaying the token name and informing you that the action cannot be undone.
- Click Revoke to confirm the action.
To close the confirmation window without revoking the token, click Cancel or the X icon.
Revoking an API token is an irreversible action. Applications or integrations using the revoked token will no longer be able to authenticate with it. Make sure the token is no longer required before confirming the revocation.