We recommend only using this method in local mode to populate new entries in the allowlist. In cloud mode, the allowlist is populated automatically.

Example

Parameters

url
string
required

The URL to block. This can be a full URL or a domain.

Ex. https://google.com or google.com

Return Value

The return value is a promise that resolves with a result object.

Success

If the addition was successful, the object will contain the following properties:

result
object
required
ok
true
required

This property will be true if the addition was successful.

url
string

The url property is the URL that was added.

Failure

However, if the addition was unsuccessful, the object will contain the following:

result
object
required
ok
false
required

This property will be false if the addition was unsuccessful.

url
string

The url property is the URL that we tried to add.

error
string

The error property will contain a human-readable error message.