API Keys

​

Steps to Generate an API Key

​

1. Access the API Keys Section

   • Log in to your Nscale dashboard.

   • Go to Settings in the navigation and select the API Keys tab.

2. Create a New API Key

   • Click the Add API Key button.

   • In the modal that appears, provide a name for the API key (e.g., “Development Key”). This helps you identify the key later.

3. Copy Your API Key

   • Once the key is generated, it will be displayed in the modal.

   • Copy your key now. You will not be able to view this key again after closing the modal

4. Close the Modal

   • After copying the key, close the modal. Your new API key is now active and ready for use.

​

Managing API keys

Visibility of API Keys: All users within your organisation can view details of API keys created by any team member in the same organisation. However, they cannot see the actual key string once it is generated.

Deleting an API Key: You can delete any API key created by anyone in your organisation. To do this:

1. Go to the API Keys section.

2. Locate the key you want to delete and click the Delete button next to it.

3. Confirm deletion by typing the name of the API key in the dialog box that appears.

4. Press delete

Best Practices for Security:

• Use environment variables or secure storage solutions to manage your keys safely.

• Rotate keys periodically and delete unused keys to reduce security risks.