This endpoint can be used to update 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.
The Mimecast secure Id of an existing policy to be updated.
urls
Array of Web URL Objects
Required
The URLs to be applied by this policy, and the actions to be taken per-URL.
policies
Array of Policy Details Objects
Required
The policy scoping details
description
String
Required
A description of the policies for future reference.
Policy Details Object
Field
Type
Required
Description
enforced
Boolean
Optional
Determines if the policy enforcement option is enabled. The default value is false.
bidirectional
Boolean
Optional
Determines if the policy should apply in both directions, where the from and to configurations are reversed.
toDate
Date String
Optional
Specifies the expiration date of a policy in ISO 8601 format (e.g. 2015-11-16T14:49:18+0000). When specified, this will override the toEternal value to false.
description
String
Required
Name of the policy for future reference.
toEternal
Boolean
Optional
Specifies if the policy should have no expiration date. Default value is true.
enabled
Boolean
Optional
Determines if the policy should be enabled to process messages. The default value is true.
fromDate
Date String
Optional
Specifies the date of a policy should go into effect, in ISO 8601 format (e.g. 2015-11-16T14:49:18+0000). When specified, this will override the fromEternal value to false.
fromEternal
Boolean
Optional
Specifies if the policy should have no start date. Default value is true.
from
Policy Target Object
Optional
Policy application based on the originator.
comment
String
Optional
Comment about the policy. This field is not visible within the Administration Console.
to
Policy Target Object
Optional
Policy application based on the recipient.
override
Boolean
Optional
Specifies if the policy should be set as an override, to be considered prior to equally-specific policies.
conditions
Policy Conditions Object
Optional
Policy application based on email transmission requirements.
Policy Target Object
Field
Type
Required
Description
emailAddress
String
Optional
The email address to apply the policy based on, when type is set to individual_email_address. Note that this field will accept any valid email address, but application is dependent on the address being an internal user.
emailDomain
String
Optional
The email domain to apply the policy based on, when type is set to email_domain.
groupId
String
Optional
The Mimecast secure id of a group (Directory or Profile Group) to apply the policy based on, when type is set to profile_group.
attribute
Attribute Object
Optional
The address object attribute to apply this policy based on, when type is set to address_attribute_value.
type
String
Optional
The component of the address object that this policy should be scoped. Possible values are: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address or free_mail_domains. Default value is everyone.
Attribute Object
Field
Type
Required
Description
name
String
Optional
The name of the user address attribute to compare value
id
String
Optional
The Mimecast secure id of the user address attribute
value
String
Optional
The value to which the user address attribute should equal
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.