Document toolboxDocument toolbox

Configuring User API Keys

User API key (or interactive API key) is an authentication token that is passed on to the Infoblox API to facilitate user authentication in an API request. The user API key acts as a secret token for authentication, and is assigned a set of access that is specific to your identity. Any users that are allowed to log in to the Infoblox Portal can create user API keys for themselves. The user API key can be used to track and control how the API is being used, such as preventing malicious use or abuse of the API.

You can also create service account users and API keys that associate with the service users. For more information, see Configuring Service API Keys.

The User API Key page lists the following information for the user API keys you have configured:

  • ID: The ID of the user API key. This is the first 32 characters of the full user API key. The ID does not contain the secret of the API key.
  • NAME: The name of the API key.
  • STATE: Indicates whether the API key is currently Enabled, Disabled, or Expired. An enabled API key is available for use while an expired key is no longer valid. You can enable and disable a valid user API key, but you cannot enable or disable an expired one. Fourteen (14) days prior to expiration of your user API key, Infoblox will notify you in-app and via email on a daily basis. You can create a new API key to replace the expiring one, and then delete the old one when it expires.
  • EXPIRES AT: The timestamp when the API key will expire or has expired. 
  • LAST USED AT: The timestamp when the API key was last used in an API operation. For troubleshooting purposes, this gives you an idea when the API key was last used in case of suspicious activities.
  • CREATED AT: The timestamp when the API key was first created.
  • UPDATED AT: The timestamp when the API key was last updated. 
  • TYPE: The type of API key. This can be one of the following:
    • Interactive: Interactive API keys are user API keys created by the signed-in users themselves.
    • Legacy: Legacy API keys are user API keys automatically generated for the signed-in users in previous Infoblox Platform releases.

Note

Infoblox will deprecate legacy keys in the near future. It is recommended that you replace your legacy key with interactive user API keys. For information about how to migrate legacy API keys to service API keys, see Migrating Legacy API Keys to Service API Keys.
  • CREATED BY: The user who created this API key.

You can do the following in this tab:

  • Click the hamburger menu on the right to select or deselect the columns to be displayed. You can also restore the settings to default.

  • Click the hamburger menu next to the API key, and then choose Enable or select the check box for the respective key and click the Enable button to enable an API key.
  • Click the hamburger menu next to the API key, and then choose Disable or select the check box for the respective key and click the Disable button to disable an API key.
  • Click the hamburger menu next to the API key, and then choose Delete or select the respective key and click the Delete button to delete an API key.

  • Enter the value that you want to search in the Search text box. The Infoblox Portal displays the list of records matching the keyword in the text box.
  • Click the Filter icon to filter the API keys by Name, State, and Type.

You can also perform the following actions: