Document toolboxDocument toolbox

Migrating Legacy API Keys to Service API Keys

Owned by Shirly Tsang
Last updated: Sept 06, 2024 by Gary Leicht
2 min read

Infoblox will deprecate legacy API keys in the near future. We recommend that you start migrating your current legacy API keys to service API keys to avoid authentication issues in your current API scripts or processes.

Note

You must be a user with the User Manage permission or an All Access Admin to be able to migrate legacy API keys.

To migrate your legacy API keys to services API keys, complete the following:

  1. Log in to Infoblox Portal as a user with the User Manage permission or as an all access admin.

  2. Create a service user, as described in Configuring Users.

  3. Create a service API key and associate it with the service account user you just created, as described in Creating Service API Keys.

  4. Repeat the previous steps if you need to create multiple service API keys.

  5. Go to the Service API Keys page on the Infoblox Portal and review the Last Used At field to determine which legacy API keys you want to replace with the newly created service API keys. For information, see Configuring Service API Keys.

  6. Change your current API scripts or processes to use the newly created key(s) you just created.

  7. Disable the legacy API keys that have not been used. You can then delete these legacy API keys at a later date.

You can also create an automated mechanism to rotate your API keys by replacing old keys with new ones.

To create an automated process for rotating your API keys, complete the following:

  1. Create an API script to create a new a service API key by using an existing legacy API key.

  2. Use the newly created service API key in an API script to stop using the legacy API key.

  3. Use the newly created service API key to disable and delete the legacy API key.