Delete a Web Security Policy

Description

This endpoint can be used to delete an existing Web Security Block or Allow List policy for domains or URLs.

The Block or Allow List API endpoint enforces the existing 5,000 limit for total URLs supported in a policy and 25,000 limit for a customer account. This API is intended to automate low volume, day-to-day transactions and is not intended for use of bulk imports or large initial imports of domains or URLs.

For more information about Web Security Policies, visit Mimecaster Central.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Web Security | Policies | Edit permission.

URI

To use this endpoint you send a POST request to:

  • /api/policy/webwhiteurl/delete-policy-with-targets

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": [
  {
   "id": "String"
  }
 ]
}
data
Field Type Required Description
id String Required The Mimecast secure Id of an existing policy to be deleted.

Response

{
 "fail": [], 
 "meta": {
  "status": 200
 }, 
 "data": [
  {
   "urls": [
    {
     "action": "String", 
     "type": "String", 
     "id": "String", 
     "value": "String"
    }
   ], 
   "id": "String", 
   "policies": [
    {
     "policy": {
      "fromEternal": true, 
      "comment": "String", 
      "enforced": false, 
      "description": "String", 
      "lastUpdated": "Date String", 
      "fromDate": "Date String", 
      "bidirectional": false, 
      "toEternal": true, 
      "createTime": "Date String", 
      "fromPart": "String", 
      "toDate": "Date String", 
      "from": {
       "attribute": {
        "name": "String", 
        "value": "String", 
        "id": "String"
       }, 
       "group": {
        "folders": [
         "String"
        ], 
        "description": "String", 
        "source": "String", 
        "folderCount": 100, 
        "parentId": "String", 
        "id": "String", 
        "userCount": 100
       }, 
       "type": "String", 
       "emailAddress": "String", 
       "emailDomain": "String"
      }, 
      "enabled": false, 
      "to": {
       "attribute": {
        "name": "String", 
        "value": "String", 
        "id": "String"
       }, 
       "group": {
        "folders": [
         "String"
        ], 
        "description": "String", 
        "source": "String", 
        "folderCount": 100, 
        "parentId": "String", 
        "id": "String", 
        "userCount": 100
       }, 
       "type": "String", 
       "emailAddress": "String", 
       "emailDomain": "String"
      }, 
      "override": false
     }, 
     "locations": [
      {
       "ip": "String", 
       "location": "String"
      }
     ], 
     "id": "String"
    }
   ], 
   "description": "String"
  }
 ]
}
meta object
Field Type Description
status Number The function level status of the request.
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
id String The Mimecast secure id of the policy, for use when referencing policy with other API calls.
description String The description for the policy (name)
urls Array of Web URL Objects The URLs to be applied by this policy, and the actions to be taken per-URL.
policies Array of Policy With Location Objects The policy scoping details
Policy with Location Object
Field Type Description
id String The Mimecast secure id of the policy.
locations Array of Source IP Location Objects An array of objects containing information regrading the source.
policy Policy Detail Response Object The policy scoping details.
Source IP Location Object
Field Type Description
ip String The source IP address.
location String The name of the location IP address.
Policy Detail Response Object
Field Type Description
enforced Boolean Is the policy enforced
bidirectional String Should the policy also apply in reverse from configuration of this policy.
toDate Date String The end date that the policy should cease to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
description String The description for the policy (name)
toEternal Boolean Should the policy continue to apply, regardless of the current date and time
enabled Boolean Should the policy be considered for emails processing through Mimecast
fromDate Date String The start date that the policy should begin to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
fromPart String Should the sender address be considered based on the envelope, header or either address
fromEternal Boolean Should the policy start to apply, regardless of the current date and time
from Policy Target Object Scope of application based on the sender address
to Policy Target Object Scope of application based on the recipient address
override Boolean Should the policy be considered for application, and apply if conditions met, prior to other policies of the same type
conditions Policy Conditions Object Conditions of the sending platform to determine if the policy should be considered
createTime Date String The creation timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
lastUpdated String The most recent modification timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
comment String A comment about the policy when created.
Policy Target Object
Field Type Description
emailAddress String The email address to apply the policy based on
emailDomain String The email domain to apply the policy based on
group Group Object The group to which the policy is scoped
attribute Attribute Object The address object attribute to apply this policy based on
type String The component of the address object that this policy should be scoped
Attribute Object
Field Type Description
name String The name of the user address attribute to compare value
id String The Mimecast secure id of the user address attribute
value String The value to which the user address attribute should equal
Group Object
Field Type Description
folders Array of Group Objects An array of all sub-groups for the current group.
userCount Number The number of users in the current group.
description String The name of the current group.
id String The Mimecast secure id of the current group.
source String The source of the current group. Will be cloud or ldap.
folderCount Number The number of sub-groups within the current group.
parentId String The Mimecast secure id of the parent group.

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/policy/webwhiteurl/delete-policy-with-targets
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":[
    {
        "id": "String"
    }
  ]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests

# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/policy/webwhiteurl/delete-policy-with-targets"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"

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

# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])

# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()

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

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

payload = {
        'data': [
            {
                "id": "String"
            }
        ]
    }

r = requests.post(url=url, headers=headers, data=str(payload))

print(r.text)
static void Main(string[] args)
        {
            //Setup required variables
            string baseUrl = "https://xx-api.mimecast.com";
            string uri = "/api/policy/webwhiteurl/delete-policy-with-targets";
            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"": [
                        {
                            ""id"": ""String""
                        }
                    ]
                }";

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

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

            //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;
            };
            System.Console.WriteLine(responseBody);
            System.Console.ReadLine();
        }
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/policy/webwhiteurl/delete-policy-with-targets"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION 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"": [
                        {
                            ""id"": ""String""
                        }
                    ]
                }"

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

#Print the response
$response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {

        //set up variables for request
        String baseUrl = "https://xx-api.mimecast.com";
        String uri = "/api/policy/webwhiteurl/delete-policy-with-targets";
        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
        java.net.URL obj = new java.net.URL(url);

        // 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");
        sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
        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);
        mac.init(signingKey);
        String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));

        // create request object
        javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();

        //set request type to POST
        con.setRequestMethod("POST");
        con.setDoOutput(true);

        //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" +
        "                \"id\": \"String\"
" +
        "    }\n" +
        " ]\n" +
        "}";
        java.io.OutputStream os = con.getOutputStream();
        os.write(postBody.getBytes("UTF-8"));
        os.close();

        //process response
        java.io.BufferedReader in = new java.io.BufferedReader(
                new java.io.InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        //return result
        java.lang.System.out.println(response.toString());
    }
Back to Top