Creating & managing API keys

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 Private DNS / Enterprise DDI portal may vary slightly.

To create a new API key:

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

2. Select the API Keys tab.
   
   

3. Click Add Key.
   
   

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

   NOTE
   Set the permissions for your API keys just as you would any other user in your NS1 account. You can add API keys to a team—allowing you to set and edit permissions in bulk.
   
   

   Option	Description
   Manage plan	Allows the key to be used to change the account type (upgrading/downgrading query limits and pricing).
   Manage users	Allows the key to be used to create or edit users and modify permissions.
   View invoices	Allows the key to be used to view account invoices.
   Manage teams	Allows the key to be used to create or edit teams and modify permissions.
   View activity log	Allows the key to be used to view the detailed account-wide activity log.
   Manage account settings	Allows the key to be used to modify admin contact information and other general settings.
   Manage API keys	Allows the key to be used to create API keys in the NS1 portal and modify settings.
   Manage payment methods	Allows the key to be used to modify the payment method (credit card) associated with the account.
   Manage IP whitelists	Allows the key to be used to add or remove IP whitelist records.
   Manage jobs	Allows the key to be used to create, edit, and remove active monitoring jobs.
   Manage lists	Allows the key to be used to add or remove notification lists.
   View jobs	Allows the key to be used to view active monitoring jobs.
   Allow zone management	Sets the default option to allow the key to be used to view and manage all zones. Optionally, you can toggle the Add exceptions button. If Allow Zone Management is selected, then the key can be used to view or manage all zones excluding any zone exceptions listed. To deny access to certain zones (i.e. adding exceptions): Start typing the name of the zone to which you would like to deny access via the API key, and then select it from the list. To deny access only to certain records within the zone: Choose Select Records, and start typing the domain name of the record or choose a record type from the drop-down menu to prevent the API key from being used to access to all records of a certain type within that zone. Additionally, you have the option to include or exclude all subdomains within the zone (ex. Including all subdomains of bar.com excludes subdomain.bar.com).
   Deny zone management	Sets the default option to prevent the API key from being used to access to all zones. Optionally, you can toggle the Add exceptions button. If “Deny Zone Management” is selected, the API key can be used only to view or manage zones (and/or records) listed as “exceptions.” To allow access to certain zones (i.e. adding exceptions): Start typing the name of the zone to which you would like to allow access via the API key, and then select it from the list.  To allow access only to certain records within the zone, choose Select Records, and start typing the domain name of the record or choose a record type from the drop-down menu to allows the API key to be used to access all records of a certain type within that zone. Additionally, you have the option to include or exclude all subdomains within the zone (ex. Including all subdomains of bar.com excludes subdomain.bar.com).
   Push to data feeds	Allows the API key to be used to send updates for data feeds.
   Manage data sources	Allows the API key to be used to create, modify, delete data sources.
   Manage data feeds	Allows the API key to be used to create, modify, delete data feeds.
   Manage global 2FA	Allows the API key to be used to enable or disable two-factor authentication (2FA) for all users in the organization.

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.
   
   

To edit an API key:

1. Navigate to Account Settings > Users & Teams.

2. Click 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.

   

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

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