Get Investigations

Overview

This endpoint retrieves a paginated list of all investigation cases. Use query parameters to sort and paginate the results, and include related data to gather a comprehensive overview in a single call. You should use this API when you need to retrieve a collection of investigations, for example, to display a list of all open cases in a custom dashboard or to feed data into a reporting engine. It's the primary method for getting a high-level overview of all investigations or for periodically polling the system to discover newly created cases.

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/investigations

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
page[offset]	integer	Number of records to skip (starts from 0th record).
page[limit]	integer	Number of records to fetch on a page.
sort	string	Single column to sort by value. By default, the records are sorted in ascending order. Example: sort by the "created" column
include	string	Specifies related resources to include in the response payload. Use this parameter to retrieve associated data in a single API call, reducing the need for subsequent requests. Example: When retrieving an investigation, including `evidence` will return both the investigation details and the related evidence data.
Accept-Encoding	string	Enable GZIP Compression to return compressed data. Example: gzip, deflate, br

Response

Response example

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 45
  },
  "data": [
    {
      "type": "investigations",
      "id": "0dc44100-430f-11ee-8b79-000000000000",
      "attributes": {
        "created": "2023-08-25T06:17:22.960Z",
        "lastModified": "2023-08-25T06:17:22.960Z",
        "name": "MVISION_API_EDR_BVT_00_2023-08-25T10:45:09.966333",
        "owner": "unknown",
        "summary": "",
        "source": "unknown",
        "isAutomatic": true,
        "hint": "MVISION_API_EDR_vaii00_{{date}}{{int}}",
        "caseType": "Malware",
        "investigated": true,
        "status": "In progress",
        "priority": "Unspecified"
      }
    }
  ],
  "links": {
    "self": "/edr/v2/investigations?page[offset]=0&page[limit]=1",
    "first": "/edr/v2/investigations?page[offset]=0&page[limit]=1",
    "prev": "/edr/v2/investigations?page[offset]=1&page[limit]=1",
    "next": "/edr/v2/investigations?page[offset]=1&page[limit]=1",
    "last": "/edr/v2/investigations?page[offset]=44&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.