The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Configuring API keys

Prev Next

If the IAM domain you use to access the Trellix UI ends in fireeye.com, follow these steps to configure API keys:

  1. Log in to the Email Security — Cloud Web Portal or IAM console.

  2. Click on My Settings in the top navigation bar.

    My_Settings.png
  3. Click the API Keys tab in the IAM console.

  4. Click Create API Key.

    create_api_key.png
  5. On the Manage API Key page, specify the following:

    • API key name.

    • Expiration time for the API key. The expiration time of API keys should be set as “100d” for 100 days, or “1y” for 1 year, for example.

    • Products. Select both “Email Threat Prevention” and “Identity Access Management”.

    assign_product_api_key.png
  6. Select all entitlements as shown below.

    select_entitlements_api.png

    For any API access, the following entitlements are required:

    • iam.users.browse

    • iam.orgs.self.read

    For accessing alerts APIs, the following additional entitlements are required:

    • etp.alerts.read

    For accessing trace APIs, the following additional entitlements are required:

    • etp.email_trace.read

    For accessing quarantine APIs, the following additional entitlements are required:

    • etp.quarantine.update

    • etp.quarantine.read

    • etp.quarantine.delete

  7. To download or copy an API key, click the download or copy icon in the bottom right corner.

    copy_api_key.png
  8. Click Create API Key.