This documentation supports releases of BMC Helix Portal up to December 31, 2021. To view the latest version, select the version from the Product version menu.

Setting up user-level API keys

As a user, you can create API keys for programmatically accessing the product.

The API key includes the access key and the secret key similar to the user name and the password used for accessing the product console. The tenant administrator can create multiple API users (in other words, multiple keys), while an individual user can create a maximum of two keys. Creating two keys can be useful when you want to set different expiry dates. Even if you deactivate one of the keys, it counts towards your limit of the two keys. To understand the concept of API keys, see User access.

To create, edit, and delete API keys

Navigate to the user icon displayed at the top right of your screen, click API keys. On the API keys page, click Add key

The configuration details required for creating, editing, and deleting an API key is very similar to the configuration details required for creating an API user. For more information, see Setting up API users for programmatic access.

Unlike API users that are assigned access permissions via roles, the user-level API keys inherit permissions from the individual user.


The user who creates an access key receives a bell notification two days before the key expires.

Was this page helpful? Yes No Submitting... Thank you