Creating API keys

You can create an API key and use it to authenticate API requests to manage your IBM® NS1 Connect® account.

NS1 Connect is built using an API-first architecture, meaning you can use the API to do almost anything that can be done in the web-based UI. This includes account management tasks, creating and managing DNS zones and records, applying traffic steering configurations, enabling third-party integrations, and more.

Attention: 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.

Before you begin

  • You must have the Manage API keys permission enabled.

Procedure

  1. Click the User Settings icon and select Users & teams.
  2. Click the API keys tab.
  3. Click Create API key.
  4. In API key name, enter a name for the API key.
  5. In API key secrets expire after, select the number of days for which the API key secret remains valid. An API key remains valid only while at least one associated secret is not expired. To set a custom expiration period, select Custom and enter the number of days.
    Note: If you select No expiration, the API key remains valid indefinitely, and you cannot rotate its secret. You can specify an expiration duration for an API key secret only when you create the API key.
  6. Adjust the permissions for this API key as desired. For more information, see Account permissions.
    Note: As a best practice, API keys should always be configured with the minimum level of access necessary to perform their intended function.
  7. Click Save API key.
  8. Copy and store the API key secret securely for future reference.
    Warning: Copy the API key secret before you close the window or navigate away from the page. You cannot retrieve the secret later. If you lose the secret, you must generate a new API key.

Result

The API key appears in the API key table.

You can rotate an API key secret before it expires or if it becomes compromised. NS1 Connect supports up to two secrets for a single API key, which enables you to rotate secrets without interrupting API access. For more information, see Managing API key secrets.