NS1 Status

Articles in this section

Creating & managing API keys

  • Updated
Follow
UPDATE
Refer to this article to learn more about new and improved API key security management.

The instructions below detail the process for creating an API key in the Managed DNS portal (https://my.nsone.net). API keys allow you to make programmatic edits to your configuration and work with supported integrations. Instructions for managing API keys within the NS1 Enterprise DDI portal may vary slightly.

To create a new API key:

  1. Log in to the portal, click your username in the upper-right corner to reveal the drop-down menu, and navigate to Account Settings > Users & Teams.

    users_and_teams.png

  2. Select the API Keys tab.

    API_keys.png

  3. Click Add Key.

    manage_keys__illustrator_merge_.png

  4. Enter a name for the key and modify permissions, as desired.
    NOTE

    API keys can be configured to include certain permissions, similar to applying permissions to an individual user or team. You can add API keys to a team—allowing you to set and edit permissions in bulk. For more information about API key permissions, refer to Managing User & Team Permissions.

  5. When finished, click Create Key.

  6. IMPORTANT: Do not navigate away from the page without first toggling the show/hide icon to display the API key secret. Record the API key in a secure password manager or key vault for future reference. You will not be able to view the key after navigating away from this page. Read this article about API key security for details.

    API_Key_examples.png

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

To delete 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 delete, click the delete (trash can) icon.

    manage_pencil_trash_icon.png

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

    delete_key.png

 

 

Related articles