How to get API keys

Modified on Wed, 4 Sep at 9:59 PM

Personal API Key:

Personal API keys serve as unique identifiers for individual users within a team or organisation. Each user typically has their own personal API key, which allows systems to recognize and authenticate them when accessing services or resources. These keys are tied to specific user accounts and are used to track individual actions and permissions within the system. Personal API keys provide a level of security and accountability by ensuring that each user's activities are attributed to their respective key.

Steps to obtain Personal API Key:

Personal API keys are created automatically for each user upon account registration.
To obtain your personal API key, click on your profile button located in the top right corner of the screen, then select Profile Settings from the dropdown menu.
From the Personal API Key(s) section, copy the API key by clicking on Show API Key button.

General API Key:

General API keys, on the other hand, are versatile tools designed for use in command-line interfaces (CLI) or continuous integration/continuous deployment (CI/CD) pipelines. Unlike personal API keys, which are tied to individual users, general API keys can be shared among team members or used for automated processes. When utilizing a general API key, the activities performed will be attributed to the owner of the key, providing transparency and accountability for actions carried out through automated systems.

Steps to obtain General API key:

Click on your profile button located in the top right corner of the screen, then select Profile Settings from the dropdown menu.
In the profile settings page, locate and click on the Create General API Key button.
You will be prompted to enter a name for your API key. Provide a descriptive name that helps you identify its purpose.
After entering the API key name, click on the "Create" button to generate the API key.
Once the API key is created, you will be provided with an option to reveal the key. Click on Click to show API key to display the key.
Copy the API key to your clipboard for future use.