URLs

Describes Philter's URL filter.

Filter
This filter identifies URLs such as myhomepage.com, http://myhomepage.com/folder/page.html, and www.myhomepage.com/folder/page.html in text.
Required Parameters
This filter has no required parameters.
Optional Parameters
Parameter
Description
Default Value
urlFilterStrategies
A list of filter strategies.
None
enabled
When set to false, the filter will be disabled and not applied
true
ignored
A list of terms to be ignored by the filter.
None
requireHttpWwwPrefix
When set to true, only URLs that begin with http or www will be filtered.
true
Filter Strategies
The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of REDACT is used. When multiple filter strategies are given the filter strategies will be applied in as they are listed. See Filter Strategies for details.
Strategy
Description
REDACT
Replace the sensitive text with a placeholder.
RANDOM_REPLACE
Replace the sensitive text with a similar, random value.
STATIC_REPLACE
Replace the sensitive text with a given value.
CRYPTO_REPLACE
Replace the sensitive text with its encrypted value.
HASH_SHA256_REPLACE
Replace the sensitive text with its SHA256 hash value.
Conditions
Each filter strategy may have one condition. See Conditions for details.
Conditional
Description
Operators
TOKEN
Compares the value of the sensitive text.
== , !=
CONTEXT
Compares the filtering context.
== , !=
CONFIDENCE
Compares the confidence in the sensitive text against a threshold value.
< , <=, > , >=, ==, !=
Example Filter Profile
{
   "name": "urls-example",
   "identifiers": {
      "url": {
         "requireHttpWwwPrefix": true,
         "urlFilterStrategies": [
            {
               "strategy": "REDACT",
               "redactionFormat": "{{{REDACTED-%t}}}"
            }
         ]
      }
   }
}

Tracking Numbers

VINs

Last updated 3 months ago

Parameter	Description	Default Value
`urlFilterStrategies`	A list of filter strategies.	None
`enabled`	When set to false, the filter will be disabled and not applied	`true`
`ignored`	A list of terms to be ignored by the filter.	None
`requireHttpWwwPrefix`	When set to true, only URLs that begin with `http` or `www` will be filtered.	`true`

Strategy	Description
`REDACT`	Replace the sensitive text with a placeholder.
`RANDOM_REPLACE`	Replace the sensitive text with a similar, random value.
`STATIC_REPLACE`	Replace the sensitive text with a given value.
`CRYPTO_REPLACE`	Replace the sensitive text with its encrypted value.
`HASH_SHA256_REPLACE`	Replace the sensitive text with its SHA256 hash value.

Conditional	Description	Operators
`TOKEN`	Compares the value of the sensitive text.	`==` , `!=`
`CONTEXT`	Compares the filtering context.	`==` , `!=`
`CONFIDENCE`	Compares the confidence in the sensitive text against a threshold value.	`<` , `<=`, `>` , `>=`, `==`, `!=`