---
title: "Configuring Service API Keys"
canonical: "https://docs.infoblox.com/space/BloxOneCloud/35397908/Configuring%20Service%20API%20Keys"
format: markdown
---
<span style="color: #000000">The service API key is a unique identifier that is used to facilitate API authentication in an API request initiated by a service user. Service users are not allowed to sign in to Infoblox Portal. They are service accounts that are used by applications to access Infoblox Portal through the API. Each service API key is associated with a service account user. A service account user can be associated up to 10 service API keys. </span>

<span style="color: #000000">You can create service API keys for specific purposes. For example, you can use a service API key to authenticate an API call to automate a process to generate reports on Infoblox Portal and send the report to yourself via email. The service API key is the token key that you use in your command when executing the API call. You can also create service users and service API keys for user management purposes. For example, you can create a service user called "SCIM delete user" and associate it with a service API key, so you can use the key to execute an API call to delete invalid users safely and to automate the cleanup process of invalid users. In this case, invalid users can be those who have left your company or those who are not allowed to log in to your system for specific reasons.</span>

<span style="color: #000000">The Service</span><span style="color: #000000">* API Key*</span><span style="color: #000000"> page lists the following for all the API keys you have configured:</span>

- <span style="color: #000000">**ID**</span><span style="color: #000000">: The ID of the API key. This is the first 32 characters of the full service API key, which does not contain the secret of the key.</span>
- <span style="color: #000000">**NAME**</span><span style="color: #000000">: The name of the API key.</span>
- <span style="color: #000000">**STATE**</span><span style="color: #000000">: Indicates whether the API key is currently </span><span style="color: #000000">**Enabled**</span><span style="color: #000000">,</span><span style="color: #000000">** Disabled**</span><span style="color: #000000">, or </span><span style="color: #000000">**Expired**</span><span style="color: #000000">. 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 service API key, Infoblox Platform 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.</span>
- <span style="color: #000000">**EXPIRES AT**</span><span style="color: #000000">: The timestamp when the API key will expire or has expired. </span>
- <span style="color: #000000">**LAST USED AT**</span><span style="color: #000000">: 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.</span>
- <span style="color: #000000">**CREATED AT**</span><span style="color: #000000">: The timestamp when the API key was first created.</span>
- <span style="color: #000000">**UPDATED A**</span><span style="color: #000000">T: The timestamp when the API key was last updated. </span>
- **ACCESS VIEW**: The access view to which you have assigned to the API key. For information about access views and how to use them, see<span style="color: #ff5630"> </span><u><span style="color: #ff5630">*[Configuring Access Views](https://docs.infoblox.com/space/BloxOneCloud/680362523)*</span></u><span style="color: #ff5630">.</span>
- <span style="color: #000000">**TYPE**</span><span style="color: #000000">: The type of API keys. This can be one of the following:</span>
  - <span style="color: #000000">**Legacy:**</span><span style="color: #000000"> Legacy keys are user API keys that were automatically generated for signed-in user in previous releases. Infoblox will deprecate legacy keys in the near future. For information, see </span><span style="color: #000000">*[Configuring User API Keys](https://infoblox-docs.atlassian.net/wiki/spaces/BloxOneCloud/pages/35430405)*</span><span style="color: #000000">.</span>
  - <span style="color: #000000">**Interactive**</span><span style="color: #000000">: Interactive keys are user API keys that signed-in users created for themselves. All signed-in users are allowed to create user API keys for themselves. For information, see </span><span style="color: #000000">*[Configuring User API Keys](https://infoblox-docs.atlassian.net/wiki/spaces/BloxOneCloud/pages/35430405)*</span><span style="color: #000000">. </span>
  - <span style="color: #000000">**Service**</span><span style="color: #000000">: Service API keys are API keys created for service account users. These keys are used to facilitate API authentication between devices. No signed-in users are involved in the API requests. </span>
- <span style="color: #000000">**CREATED BY**</span><span style="color: #000000">: The user who created this API key.</span>
- <span style="color: #000000">**UPDATED BY**</span><span style="color: #000000">: The user who last updated this API key.</span>

<span style="color: #000000">You can do the following in this tab:</span>

- <span style="color: #000000">Click the option menu next to the checkbox to select or deselect the columns to be displayed. You can also restore the settings to default.</span>
- <span style="color: #000000">Click the option menu next to the checkbox, and select </span><span style="color: #000000">**Enable**</span><span style="color: #000000"> or select the check box for the respective key and click the </span><span style="color: #000000">**Enable **</span><span style="color: #000000">button to enable an API key.</span>
- <span style="color: #000000">Click the option menu next to the checkbox, and select </span><span style="color: #000000">**Disable**</span><span style="color: #000000"> or select the check box for the respective key and click the </span><span style="color: #000000">**Disable **</span><span style="color: #000000">button to disable an API key.</span>
- <span style="color: #000000">Click the option menu next to the checkbox, and select </span><span style="color: #000000">**Delete**</span><span style="color: #000000"> or select the respective key and click the </span><span style="color: #000000">**Delete**</span><span style="color: #000000"> button to delete an API key.</span>
- <span style="color: #000000">Select a key to view the details on the right-hand panel. If you do not want to view the details, click the information button (letter i inside a square).</span>
- <span style="color: #000000">Enter the value that you want to search in the </span><span style="color: #000000">**Search**</span><span style="color: #000000"> text box. Infoblox Portal displays the list of records matching the keyword in the text box.</span>
- <span style="color: #000000">Click the filter button to filter the API keys by </span><span style="color: #000000">**Name**</span><span style="color: #000000">, </span><span style="color: #000000">**State**</span><span style="color: #000000">, and </span><span style="color: #000000">**Type**</span><span style="color: #000000">.</span>

<span style="color: #000000">The following table lists the permissions required to perform tasks associated with service API key management:</span>

| <span style="color: #000000">**Tasks**</span> | <span style="color: #000000">**User Roles/ User Groups**</span> | <span style="color: #000000">**Required Permissions**</span> |
| --- | --- | --- |
| <span style="color: #000000">Create service users</span> | <span style="color: #000000">Administrators</span><br><span style="color: #000000">Administrator Role</span> | <span style="color: #000000">All Access </span> |
| <span style="color: #000000">Custom role</span> | <span style="color: #000000">User Manage</span> |
| <span style="color: #000000">Create service API keys</span> | <span style="color: #000000">Administrators</span><br><span style="color: #000000">Administrator Role</span> | <span style="color: #000000">All Access </span> |
| <span style="color: #000000">Custom role</span> | <span style="color: #000000">Service API Keys Create</span> |

<span style="color: #000000">You can also perform the following actions based on your permissions:</span>

> Macro (children)