Document toolboxDocument toolbox

Blacklist Rule

Field NameData TypeRequired (Yes/No)Associated GUI FieldAssociated PAPI MethodUsage and Guidelines
Header-blacklistruleStringYes

Example: BlacklistRule
parentStringYesNameblacklist_rulesetsExample: blacklist-ruleset1
domain_nameStringYesDomain Name
Use this to match domain names. You cannot use the characters * and ,, in the domain name. The domain name cannot exceed 255 characters. Example: www.foo.com
_new_domain_nameStringNo

Example: www.bar.com
actionStringYesActionblacklist_action The valid value is PASS or REDIRECT.
Example: PASS

Examples

This section contains examples of how to create data files for blacklist rules. All examples use comma as the separator. You can use other supported separators, such as semicolon, space, or tab.

Adding a Blacklist Rule

This example shows how to import a blacklist rule.

header-blacklistrule,parent*,domain_name*,action* BlacklistRule,BlackList,foobar.com,REDIRECT

Overwriting Blacklist Rule Data

This example shows how to overwrite the action of a blacklist rule.

header-blacklistrule,parent*,domain_name*,action* BlacklistRule,BlackList,foobar.com,PASS