Skip to main content

API Keys

Prerequisites

Access Level:Super-admin
Permission Requirements
  • . System Settings
    • View system settings (overrides for deployment)
  • . System Settings Administration
    • Edit (or create) system settings
    • Delete system settings (will default to deployment file)

Create a New API Key​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Click the Create new API key button in the top right panel.
  5. In the pop-up, enter the key type, expiration date and optional description.
  6. Click Create.
  7. In the new pop-up, click Copy.
  8. Paste the API key where necessary.
  9. Click Close.

View an API Key​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Select the API key to view.
  5. Click the View button in the top right panel.
  6. In the left panel, view the API key name, description, created and last modified dates.

Refresh an API Key List​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Click the Refresh button in the top right panel.

Delete API Key(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Select the API key(s) to delete.
  5. Click the Delete button in the top right panel.
  6. In the prompt, click Delete.
caution

Deleting an API key is a permanent action and cannot be undone.