Create Managed URL

Add a URL to the Targeted Threat Protection - URL Protection black / white list.


  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Services | Targeted Threat Protection - URL Protect | Edit permission.


To use this endpoint you send a POST request to:

  • /api/ttp/url/create-managed-url

Request Headers

The following request headers must be included in your request:

Authorization Please see the Authorization guide for more information on building the Authorization header.

A randomly generated GUID, for example,

x-mc-app-id The Application ID provided with your Registered API Application.

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

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

 "data": [
   "comment": "String", 
   "disableRewrite": false, 
   "url": "String", 
   "disableUserAwareness": false, 
   "disableLogClick": false, 
   "action": "String", 
   "matchType": "String"
matchType String Optional Set to "explicit" to block or permit only instances of the full URL. Set to "domain" to block or permit any URL with the same domain.
disableRewrite Boolean Optional Disable rewriting of this URL in emails. Applies only if action = "permit". Default false.
action String Required Set to "block" to blacklist the URL, "permit" to whitelist it.
comment String Optional A comment about the why the URL is managed for tracking purposes.
disableUserAwareness Boolean Optional Disable User Awareness challenges for this URL. Applies only if action = "permit". Default false.
url String Required The URL to block or permit. Do not include a fragment (#).
disableLogClick Boolean Optional Disable logging of user clicks on the URL. Default is false.


 "fail": [], 
 "meta": {
  "status": 200
 "data": [
   "comment": "String", 
   "domain": "String", 
   "disableUserAwareness": false, 
   "disableLogClick": false, 
   "action": "String", 
   "matchType": "String", 
   "scheme": "String", 
   "disableRewrite": false, 
   "id": "String", 
   "port": -1
meta object
status Number The function level status of the request.
comment String The comment that was posted in the request.
domain String The managed domain.
disableRewrite Boolean If rewriting of this URL in emails is disabled.
port Number If rewriting of this URL in emails is disabled.
disableUserAwareness Boolean If User Awareness challenges for this URL are disabled.
disableLogClick Boolean If logging of user clicks on the URL is disabled.
action String Either block of permit.
matchType String Either explicit - applies to the full URL or domain - applies to all URL values in the domain.
scheme String The protocol to apply for the managed URL.
id String The Mimecast secure ID of the managed URL.

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/url/create-managed-url
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

        "matchType": "String",
        "disableRewrite": False,
        "action": "String",
        "comment": "String",
        "disableUserAwareness": False,
        "url": "String",
        "disableLogClick": False
import base64
import hashlib
import hmac
import uuid
import datetime
import requests

# Setup required variables
base_url = ""
uri = "/api/ttp/url/create-managed-url"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"

# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"

# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 ="base64"), ':'.join([hdr_date, request_id, uri, app_key]),

# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.encodestring(hmac_sha1).rstrip()

# Create request headers
headers = {
    'Authorization': 'MC ' + access_key + ':' + sig,
    'x-mc-app-id': app_id,
    'x-mc-date': hdr_date,
    'x-mc-req-id': request_id,
    'Content-Type': 'application/json'

payload = {
        'data': [
                'matchType': 'String',
                'disableRewrite': False,
                'action': 'String',
                'comment': 'String',
                'disableUserAwareness': False,
                'url': 'String',
                'disableLogClick': False

r =, headers=headers, data=str(payload))

print r.text
static void Main(string[] args)
            //Setup required variables
            string baseUrl = "";
            string uri = "/api/ttp/url/create-managed-url";
            string accessKey = "YOUR ACCESS KEY";
            string secretKey = "YOUR SECRET KEY";
            string appId = "YOUR APPLICATION ID";
            string appKey = "YOUR APPLICATION KEY";

            //Generate request header values
            string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
            string requestId = System.Guid.NewGuid().ToString();

            //Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
            System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));

            //Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
            byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));

            //Build the signature to be included in the Authorization header in your request
            string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);

            //Build Request
            System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
            request.Method = "POST";
            request.ContentType = "application/json";

            //Add Headers
            request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
            request.Headers.Add("x-mc-date", hdrDate);
            request.Headers.Add("x-mc-req-id", requestId);
            request.Headers.Add("x-mc-app-id", appId);

            //Add request body
            //Create and write data to stream
            string postData = @"{
                    ""data"": [
                            ""matchType"": ""String"",
                            ""disableRewrite"": False,
                            ""action"": ""String"",
                            ""comment"": ""String"",
                            ""disableUserAwareness"": False,
                            ""url"": ""String"",
                            ""disableLogClick"": False

            byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);

            System.IO.Stream stream = request.GetRequestStream();
            stream.Write(payload, 0, payload.Length);

            //Send Request
            System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();

            //Output response to console
            System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
            string responseBody = "";
            string temp = null;
            while ((temp = reader.ReadLine()) != null)
                responseBody += temp;
#Setup required variables
$baseUrl = ""
$uri = "/api/ttp/url/create-managed-url"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"

#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid

#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)

#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
                "x-mc-date" = $hdrDate;
                "x-mc-app-id" = $appId;
                "x-mc-req-id" = $requestId;
                "Content-Type" = "application/json"}

#Create post body
$postBody = "{
                    ""data"": [
                            ""matchType"": ""String"",
                            ""disableRewrite"": False,
                            ""action"": ""String"",
                            ""comment"": ""String"",
                            ""disableUserAwareness"": False,
                            ""url"": ""String"",
                            ""disableLogClick"": False

#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url

#Print the response
public static void main(String[] args) throws,, {

        //set up variables for request
        String baseUrl = "";
        String uri = "/api/ttp/url/create-managed-url";
        String url = "https://" + baseUrl + uri;
        String accessKey = "YOUR ACCESS KEY";
        String secretKey = "YOUR SECRET KEY";
        String appId = "YOUR APPLICATION ID";
        String appKey = "YOUR APPLICATION KEY";

        //create URL object obj = new;

        // set guid for x-mc-req-id header
        String guid = java.util.UUID.randomUUID().toString();

        // set date for x-mc-date header
        java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
        String date = sdf.format(new java.util.Date());

        //create signature for the Authorization header
        String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
        String hmacSHA1 = "HmacSHA1";
        javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
        javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
        String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));

        // create request object con = ( obj.openConnection();

        //set request type to POST

        //add reuqest headers
        con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
        con.setRequestProperty("x-mc-req-id", guid);
        con.setRequestProperty("x-mc-app-id", appId);
        con.setRequestProperty("x-mc-date", date);
        con.setRequestProperty("Content-Type", "application/json");
        con.setRequestProperty("Accept", "application/json");

        //Add post body to the request
        String postBody = "{\n" +
        " \"data\": [\n" +
        "     {\n" +
        "         \"matchType\": \"String\",\n" +
        "         \"disableRewrite\": False,\n" +
        "         \"action\": \"String\",\n" +
        "         \"comment\": \"String\",\n" +
        "         \"disableUserAwareness\": False,\n" +
        "         \"url\": \"String\",\n" +
        "         \"disableLogClick\": False\n" +
        "     }\n" +
        " ]\n" +
        "}"; os = con.getOutputStream();

        //process response in = new
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {

        //return result