Create an API key

To work programmatically, you can create an API key to manage your account, DNS resources, traffic steering configurations, and more using the API.

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. Additionally, API keys are used for integrations with the IBM 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. You can manage API keys by deleting old or redundant API keys if they are no longer in use, as well as limiting permissions for each API key to only what is required for its intended use.

Complete the following instructions to create a new API key:

  1. Click the User Settings icon and select User & teams.
  2. Click the API Keys tab.
  3. Click Add key.
  4. In App Name, enter a name for the API key for internal reference.
  5. Select the permissions that are appropriate for the API key. Refer to Account permissions for details about each permission option.
  6. Under Access to DNS resources, indicate if the API key should be able to manage or view DNS zones associated with your account.
  7. Identify the zones and records that the API key should have access to by doing one of the following:
    • Select the Allow by default check box to allow the API key to access all zones. If, however, there are some zones and records that the API key isn't allowed access to, select them in Denied zones and records.
    • Clear the Allow by default check box to deny access to all zones. If, however, there are some zones and records that the API key is allowed access to, select them in Allowed zones and records.
  8. Under IP allow list, for each IPv4 address or CIDR from which the API key can access your account, do the following:
    1. Enter the IPv4 address or CIDR.
    2. Click Add.
  9. Optionally, select Apply this IP allow list exclusively to ignore other IP allow lists applied at the global or team level. If this is selected, the API key can only access the account from an IP address specified here.
  10. 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.
  11. Click the View icon to see the API key secret.
  12. Record the API key in a secure password manager or key value for future reference.