Skip to main content

API Keys

danger

API Keys are sensitive information. Do not share them publicly or store them in version control systems. They should not be included in client-side code.

Overview​

API keys are used to make authenticated requests from your backend applications to the Engage Management API.

Creating an API Key​

To create an API key, follow these steps:

  1. Navigate to the Settings section in the Engage Operator UI.
  2. Click on API Keys.
  3. Click on the Create New API Key button.

engage-create-api-key-via-ui

  1. Enter a description for the API key to help you identify its purpose.
  2. Select a duration for the API key. By default, the key will be valid for 30 days, but you can choose a different duration if needed.
  3. Click Create to generate the API key.

engage-create-api-key-via-ui

Enable/Disable an API Key​

To enable/disable an API key, follow these steps:

  1. Navigate to the Settings section in the Engage Operator UI.
  2. Click on API Keys.
  3. Locate the API key you want to enable/disable in the list.
  4. Click the toggle switch in the Enabled column to enable or disable the API key.

engage-enable-disable-api-key-via-ui