PATCH - Exclusions by ID

Prev Next

Overview

This endpoint updates an existing detection exclusion. Target an exclusion using its exclusionId in the path and provide the new or modified attributes in the request body. The API applies the changes and returns a job ID confirming the update. Use this API to modify an exclusion as your environment changes. This is necessary when a trusted application is updated (requiring a new hash) or its file path changes. This API ensures your detection tuning remains accurate over time, preventing previously-created exclusions from becoming outdated and ineffective.

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)

PATCH https://{Trellix EDR_gateway_URL}/edr/v2/remediation/exclusions/{exclusionId}

Example — {exclusionId}: 8e63d190-51e5-4f10-8367-e84f58795e4d

Request

Request headers
Authorization: Bearer <your_bearer_token>
Content-Type: application/vnd.api+json
x-api-key: <your_api_key>
  • 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.

Request body
{
  "data": {
    "id": "79cd8e83-4af1-4887-8d69-3d6282e4247f",
    "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

Parameters

Data type/Values

Description

exclusionId

string

Unique identifier for threat exclusion

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

200

OK

Your request was processed successfully. The server has returned the requested data.

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.