Step 4 - Create an API Key
Last updated
Last updated
In Neurelo, an API Key is a security credential that grants permissions to access the APIs for a specific environment. It serves as a form of authentication, allowing applications or users to make authorized requests to the API. API Keys are included in API requests to verify the identity and permissions of the requester. These api keys help ensure secure and controlled access to the API's functionality and data.
Step 4 of the onboarding flow is to create an api key within the newly created environment.
Creating an api key is a vital step as part of activating an environment, especially when working with API endpoints. This key is used for securing and authorizing your API interactions, and passed with the API requests. Here’s how to create one:
Initiating API key Creation:
On the Quickstart dashboard, find the section for "Create an API Key"
Click on the "New API Key" button. This action will open a prompt for api key creation.
Configuring API Key Details:
API Key Name: You will be asked to provide a name for your new api key. Choose a name that is indicative of its use or purpose.
Permission Selection: Decide the level of permission for the api key. The options are:
Read: This permission is always pre-selected and mandatory, allowing the api key to read data.
Write: Optionally, you can also enable the "Write" permission if the api key is needed to modify or add data. This selection depends on your project requirements.
Generating the API Key:
After selecting the necessary options and filling in the information, click on "Create."
A new prompt will appear with an important alert message: "Store this private key securely - For security reasons, you won't be able to view it again in your Neurelo Account. If you lose this secret key, you'll need to generate a new one."
Please make sure to copy and save this api key in a secure location. Neurelo does not save this key and it cannot be retrieved again from the Neurelo dashboard once this step is completed.
Copying Your Generated API Key:
The prompt will display your "Generated API Key"
You can either manually "Select and Copy" or click on the "Copy" button next to the field with they api key to copy it to your clipboard.
Below the api key, you’ll also see the permissions associated with it.
Completing the Process:
Once you have securely copied and stored the API Key, click on "Close" to return to the Quickstart dashboard.
The "Close" option in the dialog box will not be activated until the api key has been "Copied"
Creating and securely storing this API Key is crucial for your project’s security and functionality in Neurelo. Ensure that the api key is kept in a secure location, as you cannot retrieve the existing key again from Neurelo for security reasons. If the key is lost, you need to revoke the existing api key and issue a new one within the Neurelo account. The Quick Start dashboard will now look something like this.
We are almost at the end of the quick start. The final step (Step 5) would be starting the runners in the environment.
