Alert read request

Prev Next

Takes an alert ID as a request and marks the alert as read.

PATCH https://<etp_instance_addr>/api/v2/public/alerts/read

Use the alert ID from the alert search response (this is a part of the API endpoint URL).

Required header

x-fireeye-api-key: <key>—Specifies your personal API key. (For FireEye IAM users)

Authorization: Bearer xxxx - Specifies your API access token (For Trellix IAM users)

Content-Type: application/json—Specifies that the server's response body is expected to be in JSON format.

Example request

curl -X PATCH --location '<etp_instance_addr>/api/v2/public/alerts/read -d '{ "alert_id": ["3z2CMqo-1124824-311c6414-2363-4014-a181-e23a606f1ae7-eb2247de"] } --header 'x-fireeye-api-key: xxxxx'

Example response

{
    "data": 
        {
            "type": "alerts",
            "operation": "read",
            "status": 
               {
                "success": ["3z2CMqo-1124824-311c6414-2363-4014-a181-e23a606f1ae7-eb2247de",
                            "3z2CMqo-1124824-ecb86afd-8d84-462d-904a-09bc0724ce26-eb2247de"]
               }
        },
 }