--- title: "Creating an API key" slug: "creating-an-api-key-4" tags: ["File Protect (FX)", "Malware Analysis (AX)", "IAM", "Email Security - Cloud", "Network Security (NX)", "Email Security — Server", "Central Management System", "Helix Enterprise", "Endpoint Security (HX)", "Product Usage", "Install and Get Started", "Helix", "Intelligent Virtual Execution "] updated: 2026-09-01T19:03:07Z published: 2026-09-01T19:03:07Z canonical: "docs.trellix.com/creating-an-api-key-4" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Creating an API key To create an API key, start at the API Keys view of the **My Settings > API Keys** page, and then open the Create API Key dialog box. This view lists the API keys created using your Trellix IAM account. The following table describes the panels and fields in the Create API Key dialog box: | Field | Description | | --- | --- | | API Key with entitlements | If selected, the access privileges of this API Key will be based upon manually selected entitlements. | | API Key with groups | If selected, the access privileges of this API Key will be based upon the associated groups and will be applicable to all organizations with which the groups are linked. Any modifications made to the associated groups will dynamically affect the access privileges of the API key. | | API Key Name | Name of the API key. | | API key expires in | Expiration period for the API key. Expiration times are specified using **s**, **m**, **h**, **d**, or **y**, for seconds, minutes, hours, or days, or years. Default: **90d** | | Products | Product types to which the API is granted access. | | Created On | Date and time that the API key was created. | | Expires In | Time remaining before the API key expires. | Depending on the programmatic changes you are enabling, you will need to assign the API key the product and product-specific entitlements needed to make those changes. For example, suppose the API key will be used to create IAM organization user accounts that need particular access privileges on Helix. The API key used to make these changes must be assigned Product “IAM” and “Threat Analytic Platform” and you grant the necessary set of entitlements under each product. Prerequisites - IAM Admin or IAM User access to the Trellix IAM Web UI. **To create an API key:** 1. Log in to the Trellix IAM Web UI. 2. Select **My Settings > API Keys**. ![CloudIAM_MyAPIKeys_ViewList.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-8c4e4be9-eb51-1a6a-eb08-421004ae451d.png?sv=2026-02-06&spr=https&st=2026-11-20T13%3A36%3A55Z&se=2026-11-20T14%3A36%3A55Z&sr=c&sp=r&sig=KhXZvbjZPtBGu1vCgdnctNZy2RRwSY7UhegdU%2Bt9NxY%3D) 3. Click **Create API Key**. ![CloudIAM_MyAPIKeys_1_DateExpiryProducts.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-53372273-911e-9918-3a32-7fad668acdf5.png?sv=2026-02-06&spr=https&st=2026-11-20T13%3A36%3A55Z&se=2026-11-20T14%3A36%3A55Z&sr=c&sp=r&sig=KhXZvbjZPtBGu1vCgdnctNZy2RRwSY7UhegdU%2Bt9NxY%3D) 4. Select either **API Key with entitlements** or **API key with groups** to specify the API Key type. 5. Enter a name for the API key. 6. Enter the expiration period for the API key. 7. Specify the product types for which the API key needs access privileges. To do this, click to open the Products list and then click to select product types. 8. Click **Next**. ![CloudIAM_MyAPIKeys_2_Entitlements.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-40a10575-388b-4ad8-779d-5024514dc333.png?sv=2026-02-06&spr=https&st=2026-11-20T13%3A36%3A55Z&se=2026-11-20T14%3A36%3A55Z&sr=c&sp=r&sig=KhXZvbjZPtBGu1vCgdnctNZy2RRwSY7UhegdU%2Bt9NxY%3D) 9. From the Available Entitlements list, select the product-specific entitlements to grant access rights to the API key. - To grant all entitlements in the list, click **Grant All**. - To grant individual entitlements, click **Grant** for each entry. 10. Click **Create API Key**. :