Trellix EDR APIs

Prev Next

Make sure to have these details ready before using any of these Trellix EDR APIs:

  • Gateway URL — get the gateway URL from the Trellix on-boarding email. For example, https://api.manage.trellix.com.

  • Authorization key — generate a token using the Trellix Developer portal or from Client Credentials option in Trellix IAM. For more information on generating Client Credentials and Token from Trellix IAM, see Managing your client credentials in IAM.

    Note

    If you encounter API SKU or Developer Hub SKU errors while accessing any information in the Trellix Developers portal or Trellix Market place, use the following links:

    The client credentials are available in your Trellix on-boarding email. However, you can follow these steps to generate credentials again

    Managing your client credentials in IAM

    To generate Client Credentials and Access Token from Trellix IAM, follow the below steps.

    1. Log in to the Trellix IAM with your user credentials.

    2. At the top right of the page, click on the user icon, and from the dropdown, select Client Credentials.

      Trellix_IAM_Client_Credentials.png

      Another page opens where you can see your Trellix Application Programming Interface (API) key.

    3. At the top right corner of the page, click Add.

    4. (optional) Add a description for the new client credentials.

    5. Select all EDR-related scopes as shown below:

      Client_Creds_IAM.png
    6. Click Create.

    7. Your Client ID and Secret will be generated as shown below:

      Creds_and_secret_key_IAM.PNG
    8. Use the following API call to obtain the tenant token, which can then be used to make API calls:

      curl --location 'https://iam.cloud.trellix.com/iam/v1.0/token?grant_type=client_credentials&scope=<scope>' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --header 'Authorization: Basic <BASICAUTH>'
      
  • x-api-key — get the x-api-key from your on-boarding email. Also, you can navigate to the API Access Information page to fetch the API key.

You can use the following scopes to perform different operations:

  • soc.hts.c — create historical search query

  • soc.hts.r — read historical search query status and results

  • soc.rts.c — create real-time search query

  • soc.rts.r — read real-time search query status and results

  • mi.user.investigate — read and write investigation cases

  • soc.act.tg and mi.user.config — read and write remediation requests

  • soc.act.tg — get threats and alerts

  • soc.edrfd.w and soc.edrfd.r — read and write activity feed configurations

The API samples help you to create requests, get status, get results, and get results in the file format:

These samples can be used to understand the usage of APIs. For more details, see Trellix Developer Portal.

For details about API rate limits, see Trellix EDR API rate limits.

Sample scripts to consume Trellix EDR APIs

To understand and better usage of these APIs, see Trellix EDR API sample scripts from Trellix GitHub repository.

Trellix EDR API integration scripts

To enable certain API workflows, see Trellix EDR API integration scripts from Trellix GitHub repository.

These scripts replace the earlier scripts available in GitHub repository.

For detailed information about how to use these scripts, see readme.md from the particular sample or integration scripts on Trellix GitHub repository.

Note

These Trellix EDR API scripts are intended solely for testing purposes. Please note that Trellix does not provide any support for it.