API key

Create API key

  1. Navigate to Settings [A] Click the gear icon in the left sidebar to settings open it. ▷ The menu settings is displayed.

  2. Manage API keys [B] Click the tab API keysin the top menu bar. ▷ The API key management page opens.

  3. Create new API key [C] Click the button + API key in the top-right corner. ▷ A form for entering the API key details is displayed.

  4. Enter API key details Enter the required information:

    Name: Enter a unique name for the API key.

    Validity date: Select an expiration date if the key should be time-limited.

    ◈ An expired API key can no longer be used and must be renewed to maintain the connection to the API.

  5. Create API key Click on Create, to create the new API key. ▷ The new API key is displayed in the list of API keys.

API key information

On the API keyslist page, you can view the following information for each API key:

API key name The name of the API key is displayed in the list to allow for clear identification.

Expiration date The expiration date of the API key is clearly displayed.

◈ Once an API key has expired, it can no longer be used, and access to the API is blocked.

Expired status If an API key has expired, this is indicated by a warning message on the right-hand side next to the key.

An expired API key must be renewed to restore the connection to the API.

Copy API key For each key, there is a Copy key button available that can be used to copy the key to the clipboard. ▷ You can use the copied key to authenticate API requests.

Delete API key Using the button an API key that is no longer needed can be removed.

Show more information Click on More information to display additional details about the API key.

Was this helpful?