Documentation

Welcome to the Mimecast API documentation. You'll find comprehensive guides to help you get started.

API Overview

Learn more about the Mimecast API and how to approach your integration.

API Concepts Learn the basic guiding principles of the Mimecast API View Doc
Authentication and Authorization Learn how to authenticate and authorize requests to the API View Doc
Authorization Learn how to authorize requests to the API View Doc
Response Codes View response codes returned by the API View Doc
Rate Limiting Learn about API rate limiting View Doc

Tutorials

View tutorial guides for common use cases.

Understanding SIEM Logs Learn about the data returned by the /api/audit/get-siem-logs endpoint View Doc
Downloading SIEM Logs Learn how to collect and output SIEM logs collected from Mimecast View Doc
Building Search Queries Information about constructing search queries View Doc

Endpoint Reference

View reference documentation for all of our available API endpoints.

Account

Endpoints that allow you to interact with Mimecast customer accounts.

Create Account As an authorized Mimecast Managed Service Provider, create a new Mimecast customer account View Doc
Disable Account As an authorized Mimecast Managed Service Provider, disable an existing Mimecast customer account View Doc
Get Account Returns account information for a Mimecast customer account View Doc
Get Products As an authorized Mimecast Managed Service Provider, returns contracted product information View Doc
Get Support Info Returns support information for a Mimecast customer account View Doc
Update Account As an authorized Mimecast Managed Service Provider, update an existing Mimecast customer account View Doc

Archiv

Endpoints that allow you to search the Mimecast archive and get archived data.

Get File Returns the contents of a file from the archive View Doc
Get Message Detail Returns a single message detail object View Doc
Get Message List Returns a list of sent or received messages for a given user View Doc
Get Message Part Returns the contents of a given message View Doc
Suche Returns a list of messages matching the requested search criteria View Doc

Blocked Sender Policy

Endpoints to create, get, update and delete blocked sender policies.

Create Policy Creates a blocked sender policy View doc
Get Policy Returns blocked sender policies View doc

Directory

Endpoints that allow you to interact with Mimecast groups.

Add Group Member Adds a user to a Mimecast group View doc
Create Group Creates a new Mimecast group View doc
Find Groups Returns Mimecast groups matching the requested search criteria View doc
Get Group Members Returns the members of a Mimecast group View doc
Remove Group Member Removes a user from a Mimecast group View doc
Update Group Updates a Mimecast group View doc

Directory Sync

Endpoints that allow you to interact with directory connections.

Execute Sync Executes a directory sync View doc
Get Connection Returns a directory connection View doc

Domain

Endpoints that allow you to interact with domains.

Create Domain Creates an internal domain in a pending state View doc
Delete Pending Domain Deletes a pending a domain View doc
Get Internal Domain Returns a list of internal domains registered on a customer account View doc
Get Pending Domain Returns a list of pending domains for a customer account View doc
Get Provision Status Returns the registration status for a given domain View doc
Get Verification Code Returns a verification code for a pending domain View doc
Verify Domain Verifies ownership of a pending domain View doc

E-Mail

Endpoints that allow you to interact with email statistics and send email using the API.

Send Email Send an email using the API View doc
File Upload Uploads a file to Mimecast that can be attached to an email or used as an HTML body View doc

Logs and statistics

Endpoints that return log events and statistics from a Mimecast customer account.

Account Activity and Access
Get Audit Events Returns audit logs in JSON format View Doc
Archiv
Get Archive Search Logs Returns archive search logs in JSON format View Doc
Get Archive Message View Logs Returns archive message view logs in JSON format View Doc

SIEM Logs
Get SIEM logs Returns pipe delimited, key value pair log files suitable for integration with SIEM systems View Doc
Targeted Threat Protection
Get Attachment Protection Logs Returns attachment protect logs in JSON format View doc
Get Impersonation Protect Logs Returns impersonation protect logs in JSON format View doc
Get URL Protection Logs Returns URL Protection logs in JSON format View doc

Managed sender

Endpoints to manipulate managed senders.

Permit or Block Sender Adds a sender to the permit or block list for a given user View doc

Message Finder (formerly Tracking)

Endpoints to track messages across the Mimecast platform.

Get Message Info Returns message information for a tracked message View doc
Suche Track messages across the Mimecast platform View doc

Targeted Threat Protection URL Protect

Endpoints to allow you to interact with the Mimecast Targeted Threat Protection URL Protect product.

Create Managed URL Adds a URL to the Targeted Threat Protection - URL Protection black / white list View doc
Get Managed URL Returns managed URL's from the Targeted Threat Protection - URL Protection black / white list View doc

User

Endpoints to allow you to interact with users.

Create user Creates a new Mimecast user View doc
Get Aliases Returns the alias email addresses associated to a user's primary email address View doc
Get Attributes Returns attributes for a given user View doc
Get Delegated Access Returns the Mimecast customer account codes that a user has permission to access View doc
Get Internal Users Returns the internal users for a Mimecast customer account View doc
Get Most Used Contacts Return the most used contacts for a given user View doc
Get Profile Returns user settings for a given user View doc
Remove Alias Removes an alias association from a user's primary email address View doc
Update Alias Associates an email address as an alias to another user View doc
Update Attributes Updates the attributes for a given user View doc
Update User Updates the user settings for a given user View doc

Feedback