Document toolboxDocument toolbox

How Do I Create an API Key?

All Python examples provided in this guide were scripted using Python 3.0.

How do I create an API key?

If you are a signed-in user on the Infoblox Portal, you can create user API keys for yourself. Your administrator cannot create user API keys for you. You can create multiple user API keys that associate with your identity for different purposes. For example, you can create a key for an API script that retrieve a list of lookalike target domains, and create another key for a script that updates security policies.

To create a new user API key, complete the following:

  1. From the Infoblox Portal, click your user name at the upper right-hand corner of the portal and select User Profile > User API Keys tab.
  2. On the User API Keys tab, click Create.
  3. In the Create User API Keys dialog, complete the following:
    • Name: Enter the name of the user API key. Use a name that identifies the purpose of the key, so you can easily locate it in the future.
    • Expires at: Click the calendar icon to select a date and time when the user API key should expire. The maximum expiration time is 56 weeks or 13 months.

      Note

      API key expiration notification: You will receive notification when your API key is about to expire. A new API key will need to be created to replace the expiring key. To create a new API key, select the expiring API key from the list of API keys and remove it by clicking Disable followed by Delete. Create a new API key as outlined in the above instructions.  

      Legacy system API keys never expire.

  4. Click Save & Close to save the configuration.
  5. Click Copy in the confirmation dialog to copy the user API key and save it for future use.

The user API key you created appears only once in the dialog box. When you close the dialog, you will not be able to retrieve it. Ensure that you copy it and save it in a place where you can locate it in the future. Use a name that identifies the key if you have multiple keys.

Back