Email Security - Cloud message ID API

Prev Next

Lists the events for a single message ID in a sorted manner. Traffic type defaults to inbound. To handle outbound traffic, set the traffic_type parameter to outbound.

GET https://<etp_instance_addr>/api/v1/events/<etp_message_id>

GET https://<etp_instance_addr>/api/v1/events/<etp_message_id>?traffic_type=outbound

Required header:

x-fireeye-api-key: <key>—Specifies your personal API key.

Example of inbound request

Values for ID and other fields are for illustration purposes only.

GET https://<etp_instance_addr>/api/v1/events/B270233545C33F0E5d264d60d

Inbound response

{
  "data": {

     "B270233545C33F0E5d264d60d":   [

    {
      "timestamp": "2020-01-03T12:29:57.921Z",
      "display_msg": "ETP assigned Message ID: B270233545C33F0E5d264d60d.",
      "action_on_msg": "MTA_SID_MSGID_INFO"
    },
    {
      "timestamp": "2020-01-03T12:29:57.928Z",
      "display_msg": "TLS mode not required for the domain. SMTP transaction initiated not using TLS. Policy: Sender IP Result: Pass.",
      "action_on_msg": "MTA_TLS_INFO"
    },
    {
      "timestamp": "2020-01-03T12:29:57.940Z",
      "display_msg": "RBL evaluation verdict: Pass.",
      "action_on_msg": "MTA_RBL_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:29:57.944Z",
      "display_msg": "Recipient accepted: jayesh@jay2.etp-testdomain5.com.",
      "action_on_msg": "MTA_RCPT_ACCEPT"
    },
    {
      "timestamp": "2020-01-03T12:30:00.220Z",
      "display_msg": "Message passed recipient level checks. Starting data analysis. Original message ID received as: <20200103175957.084480@JDEORE-MBP>",
      "action_on_msg": "MTA_MSG_DATA"
    },
    {
      "timestamp": "2020-01-03T12:30:00.220Z",
      "display_msg": "Message recipients: jayesh@jay2.etp-testdomain5.com.",
      "action_on_msg": "MTA_MSG_RCPTS"
    },
    {
      "timestamp": "2020-01-03T12:30:00.311Z",
      "display_msg": "SPF evaluation verdict: Neutral.",
      "action_on_msg": "MTA_SPF_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:30:00.334Z",
      "display_msg": "Message Attachment: malware.pdf (Type: pdf).",
      "action_on_msg": "MTA_ATT_INFO"
    },
    {
      "timestamp": "2020-01-03T12:30:00.335Z",
      "display_msg": "Custom rule verdict: Pass. scope admin",
      "action_on_msg": "MTA_POLICY_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:30:00.542Z",
      "display_msg": "Message Accepted",
      "action_on_msg": "MTA_MSG_ACCEPT"
    },
    {
      "timestamp": "2020-01-03T12:30:00.542Z",
      "display_msg": "Riskware rule matched: riskware_fixes.65023 configured to Block/Quarantine.",
      "action_on_msg": "MTA_RISKWARE_RULE_MATCH_INFO"
    },
    {
      "timestamp": "2020-01-03T12:30:00.622Z",
      "display_msg": "Message successfully delivered to 10.219.123.185:25 for recipient jayesh@jay2.etp-testdomain5.com.",
      "action_on_msg": "MTA_RCPT_DELIVERED_TEL"
    },
    {
      "timestamp": "2020-01-03T12:30:12.926Z",
      "display_msg": "Antispam evaluation verdict: Pass. Newsletter: No.",
      "action_on_msg": "MTA_AS_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:30:12.927Z",
      "display_msg": "Antivirus evaluation verdict: Pass.",
      "action_on_msg": "MTA_AV_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:31:58.658Z",
      "display_msg": "FireEye APT evaluation verdict: Fail.",
      "action_on_msg": "MTA_EX_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:31:58.658Z",
      "display_msg": "Yara Rules evaluation verdict: Pass.",
      "action_on_msg": "MTA_YARA_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:31:58.658Z",
      "display_msg": "Yara Rules evaluation verdict: Pass.",
      "action_on_msg": "MTA_EX_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:31:58.658Z",
      "display_msg": "Riskware Rules evaluation verdict: Pass.",
      "action_on_msg": "MTA_RISKWARE_VERDICT"
    },
    {
      "timestamp": "2020-01-03T12:31:58.750Z",
      "display_msg": "Message successfully delivered to 10.219.110.168:25 for recipient jayesh@jay2.etp-testdomain5.com.",
      "action_on_msg": "MTA_RCPT_DELIVERED_QUARANTINE"
    },
    {
      "timestamp": "2020-01-03T12:31:58.898Z",
      "display_msg": "Message quarantined.",
      "action_on_msg": "ETP_QUARANTINE_ACK"
    }

    ]
  },
  "meta": {
    "total": 20,
    "copyright": "Copyright 2020 Fireeye Inc"
  }
}

Example of outbound request

Values for ID and other fields are for illustration purposes only.

GET https://<etp_instance_addr>/events/00000627678A4A1063100484e?traffic_type=outbound -H 'x-fireeye-api-key: <APIKEY>'

Outbound response

{
    "data": {
        "00000627678A4A1063100484e": [
            {
                "timestamp": "2021-02-03T07:02:32.128Z",
                "display_msg": "ETP assigned Message ID: 00000627678A4A1063100484e.",
                "action_on_msg": "MTA_SID_MSGID_INFO"
            },
            {
                "timestamp": "2021-02-03T07:02:41.119Z",
                "display_msg": "Antispam evaluation verdict: Pass. Newsletter: No.",
                "action_on_msg": "MTA_AS_VERDICT"
            },
            {
                "timestamp": "2021-02-03T07:02:41.414Z",
                "display_msg": "FireEye APT evaluation verdict: Pass.",
                "action_on_msg": "MTA_EX_VERDICT"
            },
            {
                "timestamp": "2021-02-03T07:02:41.429Z",
                "display_msg": "Received message back from EX : usw2-etp-emps-outbound-qa01-01.vex.",
                "action_on_msg": "MTA_INTERNAL_MSG_ACCEPT"
            }
        ]
    },
    "meta": {
        "total": 4,
        "copyright": "Copyright 2021 FireEye Inc"
    }
}