POST - Exclusions

Prev Next

Overview

This endpoint creates a detection exclusion based on specific criteria. Provide a name, description, and exclusionArguments (like a SHA-256 hash or file path). The API registers the new rule and returns a job ID along with the unique exclusionId. Use this API to prevent a known, legitimate application from triggering future alerts. It's the primary method for programmatically allowing trusted internal tools or specific business software to operate without being flagged. This API enables the automated tuning of detection logic, reducing alert noise and ensuring that security operations can focus on genuine threats.

Authentication

Authentication type: Bearer Token, API Key.

You can create a token using client credentials obtained through the developer portal. The API Key (x-api-key) is provided in your onboarding email or on the API Access Management page.

Path (or URL)

POST https://{Trellix EDR_gateway_URL}/edr/v2/remediation/exclusions

Request

Request headers
Authorization: Bearer <your_bearer_token>
Content-Type: application/vnd.api+json
x-api-key: <your_api_key>
X-MVEDR-Source: <source_region>
X-Trace-Id: <trace_id_value>
  • Authorization: This header is used to authenticate your request. You need to replace <your_bearer_token> with the actual token you generate.

  • Content-Type: This header tells the server that the request body format is json:api. Even though this specific call has no request body, the API requires this header.

  • x-api-key: This is a custom header required by the Trellix API for authentication. You'll need to replace <your_api_key> with the key from your onboarding email or the API Access Management page.

  • X-MVEDR-Source (Optional): Indicates the region or source of the event data using the format xdrsoar:<region>. For example, xdrsoar:us-west.

  • X-Trace-Id (Optional): Supports tracking headers trace using the format workflow-id:task/step-id. For example, execution-id:task/step-id.

Request body

Example:

{
  "data": {
    "type": "threatExclusion",
    "attributes": {
      "exclusionName": "Datagenerator.exe",
      "description": "SHA256 Hash for Datagenerator executable",
      "exclusionArguments": [
        {
          "name": "SHA-256",
          "value": "51c8e205f3cb6fece20c38e75f5602f9b602c76cb0cd1c008afde60d8aebbba0"
        },
        {
          "name": "file_path",
          "value": "C:\\testing-linux\\spichap-01.exe"
        },
        {
          "name": "command_line",
          "value": "C:\\WINDOWS\\SYSTEM32\\WINDOWSPOWERSHELL\\V1.0\\POWERSHELL.EXE"
        }
      ]
    }
  }
}
Request parameters

There are no request parameters.

Response

Response example
{
  "data": {
    "type": "queue-jobs",
    "id": "te-5432",
    "attributes": {
      "status": "completed",
      "exclusionId": "8e63d190-51e5-4f10-8367-e84f58795e4d"
    },
    "links": {
      "self": "/edr/v2/remediation/queue-jobs/te-5432"
    }
  }
}

Response codes

Status

Response

Description

201

Created

Your request was successful, and a new resource was created as a result. Your request was successful, and a new resource was created. The response includes details such as the resource ID, which you can use to track or manage the resource.

400

Bad request

The server couldn't understand your request, likely due to a syntax error or an invalid parameter.

401

Access denied request

Your request was rejected because it lacks valid authentication credentials. Check your API key and token.

403

Forbidden

You are not authorized to access this resource. While your credentials may be valid, you don't have the necessary permissions.

404

Not Found

The specific resource or endpoint you requested does not exist.

415

Unsupported Media Type

The server rejected your request because the data format (Content-Type) is not supported.

429

Too Many Requests

You've exceeded the rate limit by sending too many requests in a short period. The Retry-After header in the response will tell you how long to wait before trying again.

500

Internal Server Error

Something went wrong on the server's end. This is not an issue with your request.