NS1 uses an API-first architecture, meaning almost everything you can do in the portal can be done via API. If you prefer to work programmatically, you can create an API key and apply the necessary permissions to configure resources and manage your account.
API keys are also used for integrations within the NS1 platform. Required permissions for integrations-related API keys vary based on the nature of the integration.
Warning
NS1 strongly recommends not sharing API keys between multiple users, third-party integrations, or other uses. You should delete old or redundant API keys that are no longer in use to ensure the security of your account. Also, you should limit permissions for each API key only to what is necessary for its intended use.
-
Click your username in the top right corner of the screen and click Account Settings > Users & Teams. Navigate to the API keys tab.
-
Click Add Key.
-
Enter a name for the key and modify permissions as desired.
Note
API key permissions are similar to those applied to individual user accounts. Refer to User permissions for details.
-
Once complete, click Create Key.
Warning
DO NOT NAVIGATE AWAY FROM THE PAGE. You will not be able to view the API key secret once you navigate away from the page, so you must toggle the show/hide icon to display the API key secret. Record the API key in a secure password manager or key value for future reference. Refer to Note about API key security for details.
While you cannot edit the API key secret, you can edit its permissions based on the intended use.
-
Navigate to Account Settings > Users & Teams.
-
Select the API Keys tab to view a list of API keys associated with your account.
-
Next to the API key you want to edit, click the edit (pencil) icon.
-
Make any desired modifications to the application name and permissions.
-
Click Save Changes.