GET - host-info

Overview

This endpoint retrieves detailed inventory information for managed endpoints. You can query for specific endpoints using their agent GUID (aGuid) or search for a set of endpoints using a full or partial hostName. The response is a paginated array of endpoint objects, each containing details like OS version and network interfaces. Use this API to gather context about a specific endpoint or to map a known hostname to its aGuid. It's a fundamental step in many workflows, used to enrich alerts with endpoint details or to verify an endpoint's identity before targeting it for a search or remediation action.

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/remediation/host-info

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
aGuid	string	Agent guid of the endpoint
hostName	string	Accepts a full or partial hostname. The API performs a prefix search and returns all host records where the name begins with the provided input string.
page[offset]	integer	Number of records to skip (starts from 0th record).
page[limit]	integer	Number of records to fetch on a page.
Accept-Encoding	string	Enable GZIP Compression to return compressed data. Example: gzip, deflate, br

Response

Response example

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 1
  },
  "data": [
    {
      "type": "hostInfo",
      "attributes": {
        "aGuid": "5825467E-86FA-11EF-1610-005056A431D9",
        "hostname": "3M4W10RS5X64",
        "os": {
          "major": 10,
          "minor": 0,
          "build": 17763,
          "sp": "",
          "desc": "Windows 10"
        },
        "lastBootTime": "2024-10-10T11:51:04Z",
        "netInterfaces": [
          {
            "name": "Ethernet0",
            "macAddress": "00:50:56:a4:31:d9",
            "ip": "10.26.22.121",
            "type": 6
          },
          {
            "name": "Primary",
            "ip": ""
          }
        ],
        "traceExtendedVisibility": 0,
        "hostOs": "windows"
      }
    }
  ],
  "links": {
    "self": "/edr/v2/remediation/host-info?page[offset]=0&page[limit]=20",
    "first": "/edr/v2/remediation/host-info?page[offset]=0&page[limit]=20",
    "prev": "/edr/v2/remediation/host-info?page[offset]=0&page[limit]=20",
    "next": "/edr/v2/remediation/host-info?page[offset]=0&page[limit]=20",
    "last": "/edr/v2/remediation/host-info?page[offset]=0&page[limit]=20"
  }
}

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.