An API key (Application Programming  Interface ) is a code that is used to help identify an application or a user. They can also act as a unique identifier for authentication purposes. API keys are used to control how the API's interface is used and track how it is being used. This can help prevent malicious use.


The information below provides an overview of how to create an API Key. To access the API for API keys, please click here. 


An API key can be easily created in a few simple steps.


  • From the dashboard page, scroll to Settings and click.


  • Using the left-hand side menu, click on API keys.


This will load the search/ create page. From here the following actions can be performed.

  • If there is data that can be searched for, the screen below will appear. Search for an API Key that has been created and saved previously.  API Keys can be searched by using keywords and phrases.



This page also allows the user to filter the fields being displayed, and view or edit the data that has been entered. 

  • Click on the funnel icon. This allows the data to be searched using only the specific fields that are chosen.



To filter data using specific headings the cog icon is used. 

  • Click on the cog icon to filter the data that is being displayed.
  • Uncheck the boxes to filter the data being displayed.



All previously created data can be viewed, edited, and deleted. 

  • Under the Action heading for each set of data entered, there is an ellipsis.
  • Click on the ellipsis and the Action menu will appear.
  • View, edit or delete the data that has been checked



If no data has previously been entered, the page below will load.



  • Click on Action and the Create page will load.



  • Choose the role for the API key from the drop-down menu. This will set the accessibility options. For public-facing endpoints please ensure Web Role is selected.
  • Group the API key into tags. Multiple tags can be created for an API key.
  • Describe the API key, this is for reference only. 
  • Define a list of static IPs to be whitelisted. Whitelisting an IP means granting network access only to specific IP addresses. 
  • Use the metadata key to describe and extend the API key with a key and a value pair. 
  • Click create once all information has been entered.
  • A pop-up will appear with the API key. Please make note of this and save it as it cannot be retrieved again. 



  • Once the API Key window has been closed, a preview page will load to summarise the information that has been entered. 
  • From this page the information can be edited or deleted using the Action button.