Skip to main content

Hello, how can we help you today?

Or select a category below
Getting Started
Videos

API Keys

  1. Exclaimer Knowledge Base
  2. User Manual
  3. Configuration
  4. Exchange On-Premises
Anthony Skilton
  • Updated

Description

This option allows you to manage a list of API keys used by the Exclaimer Exchange Transport Agent to authenticate the on-premises Exchange server in the Exclaimer environment.

An API key is required during the installation of the Exclaimer Exchange Transport Agent.

How to access it

REQUIRED! You need to be logged in as an Exclaimer Administrator to access the API Keys panel. 
To access API Keys during the initial configuration

To access the API Keys option during the initial configuration:

  1. Log into your Exclaimer account and launch your subscription. 
  2. From the menu pane, expand Configuration, then select Connect to Microsoft 365. 
    NOTE: If you have not yet configured any options, then the Connect to Microsoft 365 screen will appear automatically after you log in.
  3. Configure the subscription to use either Server-Side or Client-Side signatures.
    NOTE:
    - It is mandatory to configure either Server-Side or Client-Side signatures before you install the Transport Agent. 

    - If you wish to only apply Server-Side signatures for Exchange On-Premises mailboxes, we recommend that you run the Client-Side setup (without installing the User Agent) instead of the Server-Side setup. We recommend this approach because customers without Exchange Online cannot complete the Server-Side setup.

    For more information, see
    Onboarding Exclaimer for Server-Side (Microsoft 365)
    Onboarding Exclaimer for Client-Side (Microsoft 365)

  4. Select Need to support Exchange on-Premise to install the Transport Agent. 


    The Exchange On-Premises section is displayed.
To access API Keys after the initial Exclaimer setup

To access the API Keys option after the initial configuration:

    1. From the menu pane, select Configuration, then select Exchange On-Premises.

      The Exchange On-Premises section is displayed. 
Useful Information on API Keys
  • Multiple API keys can be created. This is useful if you need to install the Exclaimer Exchange Transport Agent on a new Exchange server in your environment, or if you want Exchange servers to have separate API keys.

  • It is possible to use the same API key for multiple Exchange servers.

  • API keys last for one year before expiring. The Exclaimer Exchange Transport Agent displays a warning close to the time of API key expiration in the Event Viewer logs on the Exchange server. If your API key expires before you renew it, it will prevent the servers using that API key from utilizing the Exchange On-Premises feature, resulting in no signature application.
  • Following the installation of the Exclaimer Exchange Transport Agent, it is possible to update the API key using PowerShell.

Please click on the options listed below to go through the detailed description:  

Adding an API Key

An API key is required during the installation of the Exclaimer Exchange Transport Agent.

To add an API key:

  1. Select ADD NEW KEY
  2. Enter a name for your API key.
    The name will be displayed in the list of API keys.
    We recommend: 

    Include the server that the API key has been applied on when naming the API key. For example: "MyCompany-Exch-01". This will help you identify the API key later on if you need to change or remove it.

  3. Select OK.
    The API key will be displayed.

  4. Select the Copy button to copy the API key.
    WARNING! Once you leave this page, you won't be able to see the value any more.
    The API key can then be pasted into the Exclaimer Exchange Transport Agent setup wizard.
Deleting an API Key

To delete an API key:

  1. Locate the API key you want to delete.

  2. Select the Bin icon to delete the key.
  3. Select DELETE to confirm that you want to remove this key.
    WARNING! Any Exclaimer Exchange Transport Agent configured to use this key will no longer be able to connect to Exclaimer. This action cannot be undone!