API Keys

To grant access to the api an API key is required, the key will grant access for a limited period of time and can be restricted to specific permissions when created.

To create a new API key navigate to Settings -> API Keys and select the option to create a new key. The new key dialogue requires the following settings to complete.

• A unique name to identify it from other keys.

• A role to limit the access that the API key has, currently the following default options are available

  • API Global Admin

  • API Admin

• Lifetime, defined by a start and end date, the total lifetime cannot be more than 1 year from the date created