API Keys
Learn how to create and manage API keys in Neocortex
API keys are essential for authenticating your requests to the Neocortex API. They provide a secure way to connect to the platform and interact with its features programmatically. Each API key is associated with specific permissions, allowing you to control access to different functionalities.
You can create, view, and manage your API keys through the API Keys page, which is accessible via the sidebar in the Neocortex dashboard. This centralized interface ensures you have complete control over your API authentication credentials.
Creating an API Key
Creating an API key is a straightforward process. Follow these steps to generate a new key for your application:
- Navigate to the API Keys page using the sidebar menu in the Neocortex dashboard.
- Click on the Create API Key button located at the top of the page. This will open a dialog box where you can configure your new API key.
- In the dialog box, provide a meaningful name for your API key. This name will help you identify the key later, especially if you manage multiple keys.
- Select the permissions you want to associate with the API key. Permissions define the scope of access the key will have, ensuring that only necessary actions are allowed.
- Once you have configured the name and permissions, click the Create button to finalize the creation process.
After the API key is created, a dialog box will appear displaying the value of the key. This is your only opportunity to view and copy the key, so make sure to save it securely. For convenience, you can use the Copy button to copy the key value to your clipboard.
Important
Treat your API key like a password. Store it securely and avoid sharing it publicly. If your key is exposed, unauthorized users might gain access to your account.
Managing API Keys
Managing your API keys is an essential part of maintaining the security and organization of your integration with Neocortex. The API Keys page provides a comprehensive overview of all the keys you have created, along with tools to edit or delete them as needed.
Viewing API Key Details
On the API Keys page, you can see detailed information about each key, including:
- Name: The identifier you provided during the creation of the key.
- Permissions: The scope of actions the key is allowed to perform.
- Active Status: Indicates whether the key is currently active or disabled.
- Creation Date: The date when the key was generated.
These details help you keep track of your keys and ensure they are used appropriately.
Editing an API Key
If you need to update the name or permissions of an existing API key, simply click the Edit button next to the key you want to modify. This will open a dialog box where you can make the necessary changes. After updating, save your changes to apply them.
Deleting an API Key
To remove an API key that is no longer needed, click the Delete button next to the corresponding key. Confirm the deletion in the dialog box to permanently remove the key. Deleting unused or outdated keys is a good security practice and helps prevent unauthorized access.
By regularly reviewing and managing your API keys, you can maintain a secure and organized integration with Neocortex, ensuring that your applications continue to operate smoothly and securely.