Create an API key - Fluid Topics - Latest

Fluid Topics Configuration and Administration Guide
Category
Reference Guides
Audience
public
Version
Latest

To generate an API key for an integration, proceed as follows:

  1. Select New API key.

  2. In the Name field, define a name for the integration.

    This field is mandatory, and the name must be unique. Only alphanumeric characters, dashes (–) and underscores (_) are allowed.

  3. Optionally, in the Description field, describe the task the integration performs using the API key.

  4. In the Roles section, select which roles to give the API key.

  5. Optionally, in the Access groups field, select access groups to which to add the key.

    Access groups make it possible for their users and API keys to access restricted content.

  6. In the Addresses field of the IP restrictions section, list authorized IP address or IP address ranges (using the CIDR notation). Separate IPv4 addresses and IP ranges by commas.

    This field can be left empty to allow all IPs.

  7. Select Save.

After selecting Save, a pop-up window showing the API key appear. Select Copy to copy the API key.

It is necessary to copy the API key when the pop-up window appears and to store it securely. It is not possible to display the API key again. If the API key is lost, it is necessary to generate a new one.