Skip to main content
Български Deutsch Español Français Italiano Nederlands Polski Português Русский
Submit a request Service Status

API Keys

Anthony Skilton
  • Updated

Description

API Keys is a settings panel within the the Exchange On-Premises section of Exclaimer Cloud. It allows for management of a list of API keys that the Exclaimer Exchange Transport Agent uses to authenticate securely from the on-premises Exchange server to the Exclaimer Cloud 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 Cloud Administrator to access the API Keys panel. 
To access the API Keys panel during the initial configuration
  1. From the left-hand pane, click Configuration, then select Connect to Microsoft 365.
    NOTE: The options within Connect to Microsoft 365 are only available during the initial setup. Once you have successfully configured your Exclaimer Cloud subscription, this section will not be available. 
  2. From the right-hand pane, Apply Signatures is enabled only if the authorization and syncing process has been completed.

  3. Click Exchange On-Premises.

  4. Click Continue to Exchange On-Premises.


    The Exchange On-Premises section is displayed.
  5. The API Keys panel is located in the right-hand pane.
To access the API Keys panel after the initial Exclaimer Cloud setup
  1. From the left-hand pane, click Configuration, then select Exchange On-Premises.

    The Exchange On-Premises section is displayed.

  2. The API Keys panel is located in the right-hand pane.
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. Click 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. Click OK
    The API key will be displayed.

  4. Click 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. Click the Bin icon to delete the key.
  3. Click 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 Cloud. This action cannot be undone!

Related to