The IBM NS1 Connect platform is built using 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 to manage your account, DNS resources, traffic steering configurations, and more using the API. Additionally, API keys are used for integrations with the NS1 Connect platform.
Warning: To ensure the security of your NS1 Connect account, do not share API key secrets between multiple users or third-party integrations. We recommend deleting old or redundant API keys if they are no longer in use, as well as limiting permissions for each API key only to what is required for its intended use.
Follow the instructions below to create a new API key:
-
Click your username in the upper right corner of the portal, and navigate to Settings > Users & teams.
-
Click the API keys tab to view a list of existing API keys.
-
Click Add key.
-
Enter a name for the API key for internal reference.
-
Adjust the API key permissions as desired. Refer to Account permissions for details about each permission option.
-
Under Resource Permissions, indicate whether or not the API key should be able to manage or view DNS zones associated with your account.
-
If the Allow by default option is enabled, the API key will have access to all zones except those specified under Denied zones.
-
If the Allow by default option is disabled, the API key will have access to all zones except those specified under Allowed zones.
-
-
Under Manage IP allow list for this key, enter one or more IPv4 addresses or CIDR ranges from which the API key can access your account.
-
Optionally, enable the option to Apply this IP allow list exclusively to ignore other IP allow lists applied at the global or team level. If enabled, the API key will only be able to access the account from an IP address specified here.
-
Once complete, click Save API key. The new API key appears in the list with a temporary option to show/hide the API key secret.
Warning: DO NOT NAVIGATE AWAY FROM THE PAGE until you record the API key secret. You will not be able to retrieve the API key secret after navigating away from the page.
-
Click the "i" information icon to show 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.