API keys are normally used to track and control connections and performance of how the system interface is being used; thus, it provides authentication in the calling of a program to another API to confirm a project is authorized for connection.

The benefit of API keys is that it may prevent abuse or misuse of the APIs. API keys are a initial step in cloud API security by providing the connecting API with a password-like code with a defined set of access rights.

The following permissions are needed to be able to manage API keys. The

Platform Administrator

role, which is the out-of-the-box role granted to you when the account is first created, is the only role that includes all these permissions. Alternatively, as a

Platform Administrator

, you can create Custom Roles and assign them the API keys permissions.

Permission	Description
iam.apikeys.view	Allow to view API keys
iam.apikeys.create	Allow to create API keys
iam.apikeys.update	Allow to update API keys
iam.apikeys.replace	Allow to replace API keys
iam.apikeys.delete	Allow to delete API keys
iam.apikeys.manage	Allow to manage API keys

To navigate to the API Keys page, follow these steps:

Once in the API Keys page, you can perform a series of actions to personalize your API keys needs, including the following:

By accessing the API Keys page, you are presented with the available keys that you have added to your account. Filter your API keys by using the filtering menu on the top of the page:

You can use the filter and search capabilities to do more specific searches.

To create a new API key, follow these steps:

The new API key is created and displayed under the API Keys page.

You can prevent an API key from being deleted or modified by locking it. A locked API key is represented by the

Locked icon

. You can unlock an API key at any time to update or delete it from your platform.

To lock or unlock an API key, follow these steps: