Get result

Prev Next

Overview

This endpoint retrieves the results of a completed search in a paginated JSON:API format. It's designed for applications that need to process the realtime data one page at a time. By providing the search-id and using pagination parameters, you can systematically iterate through the entire result set returned from the queried endpoints.

You should use this API when your application needs to programmatically process search results record by record. It's the ideal method for integrating search data directly into an automated workflow, a custom dashboard, or for piping results into another system for further analysis without downloading a full file.

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)

GET https://{Trellix EDR_gateway_URL}/edr/v2/searches/realtime/{search-id}/results

Example — {search-id}: rts-12212

Note

You might also find the endpoint in the Location field of the headers tab of the status call's response after the search is finished.

Request

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

  • Accept-Encoding: This is an optional header you can include to tell the server you can accept a compressed response (using gzip), which can make the data transfer faster.

Request parameters

Parameters

Data type/Values

Description

searchId

string

Search id of the search in progress.

page[offset]

integer

Number of records to skip (starts from 0th record).

page[limit]

integer

Number of records to fetch on a page.

output

string

Defines the search output type.

format

string

Defines the output format.

sort

string

Single column to sort by value. By default, the records are sorted in ascending order. If the records are prefixed with '-', sorted in descending order.

Accept-Encoding

string

Enable GZIP Compression to return compressed data.

Example: gzip, deflate, br

Response

Response parameters

Parameters

Data type

Description

Severity

string (enum: s0–s5)

BANF rule severity: potential impact of detection. For details, see Security levels.

Process_Integrity

string

Process integrity levels for Windows devices.

Root_Trace_Id

string

Root trace ID of the process group (may equal parentTraceId if detected at root process).

Related_Trace_Id

array[string]

List of traceIds representing events responsible for detection.

Process_Sha256

string

SHA-256 hash of the parent process.

Hash_Id

string

Detection ID — identical for two detections sharing same data except detectionDate/traceId.

Parents_Trace_Id

array[string]

traceIds of all ancestor processes (first = parentTraceId).

Detection_Tags

array[string]

MITRE ATT&CK tags (for example, @ATA.Execution, @ATE.T1059.001).

Process_Path, CommandLine

string

Full path and command line of the triggering process.

Rank

integer

Trellix Agent calculated rank, used internally.

Pid

integer

Process ID

Host_Name

string

Host name of the device.

DetectionDate

string (date-time)

Time of detection in EDR cloud.

ProcessName

string

Process initiating events represented by relatedTraceIds that triggered the rule.

Trace_Id

string

Autogenerated GUID for the event.

MAGUID

string

Endpoint MA (formerly McAfee Agent) GUID — uniquely identifies the device.

Version

string

Version information.

Process_Md5

string

MD5 hash of the parent process.

Event_Date

string (date-time)

Earliest timestamp for related traces as reported by the endpoint clock (UTC).

Host_OS

string (enum: windows, linux, mac)

Host OS: windows, linux, or mac.

Artifact

string

Value is Threat for detection events.

Parent_Trace_Id

string

TraceId of the Process Created event for the detection process.

Score

integer

BANF rule score / confidence level.

User

object

User name and domain: { "domain": "...", "name": "..." }.

Activity

string

Type of event

RuleId

string

BANF rule ID that triggered the detection.

Attack_Tags

array[string]

MITRE ATT&CK tactic and technique associations.

HX_Agent_Id

string

HX Agent GUID.

Process_Embed_FileName, Parent_Process_Embed_FileName

string

Embedded filenames of process and grandparent process binaries.

Parent_Process_Path, Parent_Process_CmdLine, Parent_Process_MD5, Parent_Process_Sha256, Parent_Process_Name

string

Grandparent process details (path, command line, hashes, name).

P_Parent_TraceId

string

TraceID of the grandparent process.

HostInfo.os.desc / major / minor / build / sp

string

OS description, major/minor version, build number, service pack.

HostInfo.ifaces.name / mac / ip / type

number

Network interface name, MAC address, IP address, interface type.

Response example
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 2,
    "totalHosts": 13
  },
  "data": [
    {
      "id": "fd3c5a73fcb4485d67350052f2b51cd0",
      "type": "realTimeSearchResults",
      "attributes": {
        "created": "2021-07-24T07:29:45.895Z",
        "HostInfo.hostname": "EDR-20-W2K_4",
        "HostInfo.ip_address": "10.54.1.26",
        "HostInfo.os": "Microsoft Windows [Version 6.3.9600]",
        "HostInfo.connection_status": "Online",
        "HostInfo.platform": "Windows",
        "BrowserHistory.url": "https://www.google.com/search?q=adobe+reader&oq=adobe&aqs=chrome.1.69i57j0l5.9188j0j8&sourceid=chrome&ie=UTF-8",
        "BrowserHistory.title": "adobe reader - Buscar con Google",
        "BrowserHistory.last_visit_time": "2019-11-26T19:20:29.000Z",
        "BrowserHistory.visit_count": 2,
        "BrowserHistory.visit_from": 0,
        "BrowserHistory.browser": "Google Chrome",
        "BrowserHistory.user_profile": "Administrator",
        "BrowserHistory.browser_profile": "Default",
        "BrowserHistory.url_length": 110,
        "BrowserHistory.hidden": 0,
        "BrowserHistory.typed_count": 0
      }
    }
  ],
  "links": {
    "self": "/edr/v2/searches/realtime/rts-5432/results?page[offset]=3&page[limit]=1",
    "first": "/edr/v2/searches/realtime/rts-5432/results?page[offset]=1&page[limit]=1",
    "prev": "/edr/v2/searches/realtime/rts-5432/results?page[offset]=2&page[limit]=1",
    "next": "/edr/v2/searches/realtime/rts-5432/results?page[offset]=4&page[limit]=1",
    "last": "/edr/v2/searches/realtime/rts-5432/results?page[offset]=13&page[limit]=1"
  }
}

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.