This feature will enable System Administrators to generate API keys that will be used to limit access to the BLADE URLs. The use of keys is two-fold.

Prevent unauthorized use
Prevent overuse or abuse

By default this feature is inactive and needs to be configured to be enabled. See https://bannisterlake.atlassian.net/wiki/spaces/ST/pages/2881716241

Keys can be created before activating the API Key validation.

What is an API Key

An API keys consists of:

Name
Key value
Maximum number of allowed requests
A time window specified in seconds

These keys will limit the number of blade requests that can be made within the given number of seconds.

How do I create a new API Key?

You have to be a global System Administrator in Flow to be able to create new API Keys. There will be a link to the API Key module in the System Tools section of the dashboard. If not displayed - it may need to be enabled in the Configuration page - Features tab.

API Keys link in the System Tools group

The module has a button to add a new key at the top of the grid list of existing keys.

You can use the suggested key value that is generated randomly each time the new API Key form is opened or you can enter your own custom text for use as an API key.

Sample generated key displayed in the form

The new API key will be available for use once it is saved.

API Key Names

The names assigned to the keys are to help you manage and understand the purpose for which each API key was created. Is it assigned to a specific group or task? Is this one just for testing?