Get Threat Intel Feed

Description

This feed can be used to return identified malware threats at a customer or regional grid level.

Note: This is tied to the Threat Intel feature in the Administration Console, which is currently available as an opt-in early release. Contact our Service Delivery Support Team to have this feature enabled for an account prior to expecting returned data.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Services | Gateway | Tracking | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/ttp/threat-intel/get-feed

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
     "data": [
      {
       "end": "Date String", 
       "fileType": "String", 
       "compress": "Boolean", 
       "start": "Date String", 
       "token": "String", 
       "feedType": "String"
      }
     ]
    }
data
Field Type Required Description
start Date String Optional Start Date in the ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Default is 7 days before current date.
end Date String Optional End Date in the ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Default is current date.
compress Boolean Optional Compress multiple feed files. Default is false.
fileType String Optional File type of respective feed - csv or stix. Default is csv.
feedType String Optional The scope of data to return, either for the account, or for the regions grid. Can be one of "malware_customer" or "malware_grid"
token String Optional Secure ID of the threat feed file that was previously downloaded. The Secure ID is included in every response.

Response

The response will be a data stream, and the format will vary depending on the feedType and fileType provided in the request.

For Customer CSV, the output will be:

key|FileMimeType|FileName|FileSize|MD5|Observations|RecipientAddress|Route|SHA1|SHA256|SenderAddress|SenderDomain|SendingIP|Timestamp
0|text/plain|fileName.ext|68|44d88612fea8a8f36de82e1278abb02f|1|recipient@domain1.tld|In|3395856ce81f2b7382dee72602f798b642f14140|275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f|sender@domain2.tld|domain2.tld|1.2.3.4|2015-02-04T17:20:35.485

For Grid CSV, the output will be:

key|FileMimeType|FileName|FileSize|MD5|Observations|Route|SHA1|SHA256|SendingIP|Timestamp
0|text/plain|fileName.ext|68|44d88612fea8a8f36de82e1278abb02f|1|In|3395856ce81f2b7382dee72602f798b642f14140|275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f|1.2.3.4|2015-02-04T17:20:35.485

For Customer and Grid STIX, the output will be:

{
    "type": "bundle",
    "id": "bundle--bf8be578-3953-4b80-ae84-312d149b91e8",
    "spec_version": "2.0",
    "objects": [
        {
            "type": "malware",
            "id": "malware--94b21aa9-a512-4a09-ae8a-83a24f77567f",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "name": "fileName.ext",
            "labels": [
                "virus"
            ]
        },
        {
            "type": "indicator",
            "id": "indicator--69f4511a-75c8-440f-890d-ff91ba5f300a",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "labels": [
                "malicious-activity"
            ],
            "pattern": "[file:hashes.'SHA-256' = '275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f']",
            "valid_from": "2015-07-02T09:14:59.163Z"
        },
        {
            "type": "relationship",
            "id": "relationship--4bca1b52-de50-4d91-982b-50c7256c2680",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "relationship_type": "indicates",
            "source_ref": "indicator--69f4511a-75c8-440f-890d-ff91ba5f300a",
            "target_ref": "malware--94b21aa9-a512-4a09-ae8a-83a24f77567f"
        },
    ]
}

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/ttp/threat-intel/get-feed
    Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
    x-mc-date: {dateTime}
    x-mc-req-id: {unique id}
    x-mc-app-id: {applicationId}
    Content-Type: application/json
    Accept: application/json
    
    
    {
      "data":[
        {s
            "start": "Date String",
            "end": "Date String",
            "compress": "Boolean",
            "fileType": "String",
            "feedType": "String",
            "token": "String"
        }
      ]
    }