Learn how to manage your Cleeng API keys, including generating new tokens, setting IP whitelists, removing keys, and accessing developer resources for optimal platform setup.
Accessing your API keys
You can find all your API keys in the Cleeng Dashboard under Admin & Tools > API Keys.
In this section, your API keys are listed; however, for security, the actual key values are not accessible and are displayed as strings of asterisks.
Creating an API Key
To integrate with Cleeng, you need to generate an API key.
- Click Create new API key on the right side of the API Keys section.
- Provide the name of the new token in the pop-up.
-
(Optional) In the IP Whitelist field, specify the IP addresses or CIDR ranges allowed to use this key (for example, 203.0.113.1 or 203.0.113.0/24).
- Leave the field empty to disable whitelisting.
- Click Generate Key.
Once the key is created, it will be displayed only once. This is the only opportunity to copy the key—store it securely, as it cannot be retrieved later.
Note:
- After creation, the key will no longer be visible in the dashboard. If you lose access to a key, generate a new one and use it for future integrations.
- Creating a new API key does not invalidate existing ones. Multiple API keys can be active at the same time.
- The only way to deactivate a key is to delete it
Editing an IP Whitelist
You can modify the IP whitelist for any existing API key:
- Locate the key in the API Keys table.
- Click the Edit icon on the right.
-
Update the list of allowed IP addresses or CIDR ranges in the IP Whitelist field (for example, 203.0.113.1 or 203.0.113.0/24).
- To disable whitelisting, leave the field empty.
- Click Submit.
Once saved, only the updated IP addresses or ranges will be allowed to use the key.
Removing an API Key
You can remove a key by clicking on the Delete icon on the right side of the API Keys table. Once deleted, the key is immediately invalid and can no longer be used for API requests.
More About Cleeng API
Understanding the API - this link will take you over to a dedicated Cleeng Developers site. Here you will be able to find an in-depth explanation of how an API works and how to get the most out of Cleeng's API. Our API provides you with the optimal flexibility to create and set up an offer that precisely matches your needs. Feel free to submit your work on GitHub or contact us directly.