POST - Metadata

Overview

This endpoint performs a bulk lookup to retrieve internal system metadata, like the hostId, for a given list of endpoint hostnames. You provide an array of hostnames, and the API returns a multi-status response that explicitly lists which hostnames were successfully found and which failed. This allows you to efficiently translate human-readable names into the system identifiers required for other API operations.

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

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": {
    "type": "metadata",
    "attributes": {
      "hostNames": [
        "77NSUSE15SP201",
        "DESKTOP-2HS9OV4"
      ]
    }
  }
}

Request parameters

There are no request parameters.

Response

Response example

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 1
  },
  "data": {
    "id": "aeaf39ef-1ae6-4b57-9097-f92cd2eb7627",
    "type": "metadata",
    "attributes": {
      "success": [
        {
          "status": "200",
          "message": "success",
          "hostInfo": [
            {
              "hostName": "77NSUSE15SP201",
              "hostId": "EC9B574D-DE1E-ED11-87C6-005056ACB455"
            }
          ]
        }
      ],
      "failed": [
        {
          "status": "404",
          "message": "Not Found",
          "hostNames": [
            "DESKTOP-2HS9OV4"
          ]
        }
      ]
    }
  }
}

Response codes

Status	Response	Description
207	Successful	Your request was processed. The body will contain separate lists for the hostnames that were found successfully and those that failed.
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.