Creating and managing API keys

You can create API keys to authenticate and integrate TotalFlow Optimizer with an external application. Once created, the API keys can be activated, deactivated, or renewed for a period of time in case they expire.
To create and manage the API keys:
  1. To create an API key:
    1. Go to Admin ⇒ Other ⇒ API Keys.
    2. Click Create API Key to open the dialog for creating the API key.
    3. Enter the name for the new API key.
      The key is automatically generated and enabled.
    4. To set the validity time for the API key, set the number of days under Expiration.
        Note:
      • By default, the API key automatically expires 90 days from the date of creation. You can renew an API key before the expiration date or after it expires.
    5. To use the API key generated in the Key field, click Copy. After you copy it, you can paste it in the external application that you use.
  2. To enable an API key:
    1. Go to Admin ⇒ API Keys.
    2. Right-click an API key from the list that is disabled and choose Enable.
  3. To disable an API key:
    1. Go to Admin ⇒ API Keys.
    2. Right-click an API key from the list that is already enabled and choose Disable.
  4. To renew an API key:
    1. Go to Admin ⇒ API Keys.
    2. Right-click an API key from the list and choose Renew API Key.
    3. Click Yes on the confirmation dialog.
    4. To use the new API key, click Copy.
      If necessary, you can also adjust the expiration time.
    5. To close the dialog and save the new API key settings, click OK.
      Note:
    • You cannot renew an API key that is scheduled to be deleted.
    • If an API key is grayed out, it cannot be renewed. The API key is already expired and scheduled for deletion.
  5. To delete an API key:
    1. Go to Admin ⇒ API Keys.
    2. Right-click an API key from the list that you want to delete and choose Delete API Key.
    3. Click Yes in the confirmation dialog to delete the key.
Parent topic: TotalFlow Optimizer APIs