Get Activity feed configuration with ID

Overview

This endpoint retrieves the complete details for a single activity feed configuration. Target a specific configuration by its configuration-id in the path. The response is a single object containing all settings for that feed, including its topic and destination details. Use this API to verify the settings of a specific data feed. It's the standard method for fetching the current state of a configuration before you update it, or to confirm that a new feed was created with the correct parameters. This API provides on-demand access to individual feed configurations, enabling precise and automated validation within your management workflows.

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)

<HTTPS Method>
GET https://{Trellix EDR_gateway_URL}/edr/v2/activity-feed/configurations/{configuration-id}

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 parameters

Parameters	Data type/Values	Description
configurationId	string	This is a path parameter. A unique identifier for the configuration.

Response

Response example

{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResourceCount": 1
  },
  "data": {
    "type": "activityFeed",
    "id": "8906193e-383c-4a61-9beb-b692f90e100c",
    "attributes": {
      "topic": "threatEvents",
      "clientEmailId": "test_tenant@yopmail.com",
      "configType": "s3Config",
      "enableCompressedOutput": true,
      "s3Config": {
        "s3Prefix": "username",
        "roleARN": "arn:aws:iam::0946XXXXXXXXX:role/EAF_Role_of_S3_bucket",
        "s3BucketName": "EAF_bucket",
        "awsRegion": "us-west-2"
      }
    }
  }
}

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.