API Keys

Create API Keys

  1. Navigate to Settings [A] Click on the gear icon in the left sidebar to open Settings.

    ▷ The Settings menu is displayed.

  2. Manage API Keys [B] In the top menu bar, click on the API Keys tab.

    ▷ The page for managing API keys is opened.

  3. Create a new API key [C] Click on the + API Key button 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.

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

    ◈ An expired API key is no longer usable 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 Keys list page, you can view the following information for each API key:

Name of the API key The name of the API key is displayed in the list to enable unique identification.

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

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

Expired status When an API key has expired, this is indicated by a warning message to the right of the key.

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

Copy API key A Copy key button is available for each key, which can be used to copy the key to the clipboard.

▷ You can use the copied key to authenticate API requests.

Delete API key A no-longer-needed API key can be removed using the button .

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

Last updated