Skip to main content
My preferencesSign out
Proofpoint, Inc.

Integration Keys

About Integration Keys

Integration keys are used to authenticate to the Essentials Threat API.

Creating Integration Keys

  • Navigate to Account Management > Integrations and click on the Integration Keys tab.
  • Click Add Integration Key in the upper right-hand corner.
  • You can add a description to help you remember what the integration key is for.
  • If you are an organization, the Scope field will be locked to "My Organisation Only". If you are a partner, you can select between "My Organisation and All Child Organisations". This value determines whether or not the key has permission to access data for the entities below yours in the partner hierarchy.
  • Once you click Create, you will be presented with two values: the API Key and the API Key Secret. Both values are necessary to authenticate to the Essentials Threat API. These values will not be displayed again, so be sure to save them somewhere secure.
  • The key will take up to 30 minutes to become active.

Deleting Integration Keys

  • Navigate to Account Management > Integrations and click on the Integration Keys tab.
  • Locate the key you want to delete and open the menu in the Actions column. Click Delete API Key.
  • After confirming the deletion, the key will be deactivated within 30 minutes. There is no way to undo this action.