Add Threat Intel Indicators

Description

This endpoint can be used to import a single or batch of multiple indicators.These indicators can be used to perform a specific action based on their presence.For example, a file-hash can be added with a block action to prevent the delivery of a message with an attachment matching that file-hash.Currently, only file-hashes are supported.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the BYO Threat Intelligence | Upload permission.

URI

To use this endpoint you send a POST request to:

  • /api/byo-threat-intelligence/create-batch

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": [
{
"operationType": "BLOCK",
"hashList": [
{
"provider": "Test",
"description": "Morris worm",
"hash": "4b61fd53c077baffe40a70f0b2c1c7f5f66e9e7b590aa13feaaf8a2711f3dd9d"
}
]
}
]
}
Data
Field Type Required Description
operationType String Required The action to take based on the batch of indicators. Must be one of ALLOW, BLOCK or DELETE.
hashList Array of FileHash Objects Required List of one or more file-hashes to be acted upon.
FileHash Object
Field Type Required Description
provider String Optional Provider or source of the file-hash, limited to 10 characters
description String Optional A description of the file-hash
hash String Required The file-hash value

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"batchIdToken": "eNqrVipOTS4tSs1MUbJSKouySPMKSQ12c480dtFOtAgM9o9IivJ1D9Y2Nik...",
"completionTime": "2020-06-01T19:11:46.000Z[UTC]",
"createTime": "2020-06-01T19:11:46.000Z[UTC]",
"hashCount": 10,
"operationType": "BLOCK",
"status": "COMPLETED"
}
]
}
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
batchIdToken String The Mimecast secure ID of the batch.
completionTime Date String The UTC timestamp of the batch ingestion completion in the following format: 2020-06-01T19:11:46.000Z[UTC]
createTime Date String The UTC timestamp of the batch creation in the following format: 2020-06-01T19:11:46.000Z[UTC]
hashCount Number The number of hashes within the batch.
operationType String The action provided upon batch creation. Will be one of: ALLOW, BLOCK or DELETE.
status String The current status of a batch ingestion. Will be one of: NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED, PARTIALLY_COMPLETED or PARTIALLY_FAILED.

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/byo-threat-intelligence/create-batch
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": [
{
"operationType": "BLOCK",
"hashList": [
{
"provider": "Test",
"description": "Morris worm",
"hash": "4b61fd53c077baffe40a70f0b2c1c7f5f66e9e7b590aa13feaaf8a2711f3dd9d"
}
]
}
]
}
Back to Top