This endpoint can be used to create a remediation event, by messageId or file hash. A successful call will return the incident information, and will take the same actions as a manual remediation incident created in the Administration Console. Note: Currently this endpoint does not support image file hashes.
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Services | Threat Remediation | Edit permission.
To use this endpont you send a POST request to:
The following request headers must be included in your request:
Please see the Authorization guide for more information on building the Authorization header.
A randomly generated GUID, for example,
The Application ID provided with your Registered API Application.
The current date and time in the following format, for example,
The incident code generated at creation, to be used as a reference for the remediation incident
The type of incident, with these possible values: manual, automatic or notify_only
The reason provided at the creation of the remediation incident
Search Criteria Array
The search criteria used to identify messages
The incident creation data and time
The date and time of the incident's last change
The number of messages identified based on the search criteria
The number successfully remediated messages
The number of messages that failed to remediate
The number of messages that were restored from the incident
The secure Mimecast remediation ID, can be used to get incident information
Search Criteria Array
The Mimecast code used to restore a previously remediated message
The start date of messages included. Default is one month back
The file hash used in creation of the remediation incident
The message id use in creation of the remediation incident
The restore incident code
The sender email address or domain
The end date of messages included. Default is the current day.
The recipient email address or domain
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.