NS1 status

Articles in this section

Managing API keys

  • Updated
Follow

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.

Create an API key:

  1. Click your username in the upper-right corner of the portal and select to Account Settings > Users & Teams. Navigate to the API keys tab.

    API_keys.png

  2. Click Add Key.

    manage_keys__illustrator_merge_.png

  3. 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.

  4. 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.

Edit an API key:

  1. Navigate to Account Settings > Users & Teams.

  2. Select the API Keys tab to view a list of API keys associated with your account.

  3. Next to the API key you want to edit, click the edit (pencil) icon.

    manage_pencil_trash_icon.png

  4. Make any desired modifications to the application name and/or permissions.

  5. Click Save Changes.

Delete an API key:

  1. Navigate to the API Keys tab (within Users & Teams) to view a list of API keys associated with your account.

  2. Click the delete (trash can) icon next to the API key you want to delete.

    manage_pencil_trash_icon.png

  3. When prompted, click Continue to confirm the changes.

    delete_key.png

Related articles