WAwatchguard
Exceptions (WebBlocker)

Updates the specified WebBlocker exception.

put/v1/configuration/{accountid}/exceptions/webblocker/{objectid}

Request

Path parameters

objectidstring required

ID of the WebBlocker exception to update in your FireCloud account .

Request body

idstring required

Unique ID that identifies this object.

objectstring required

Type of object.

versioninteger required

Version number of the object.

accountstring required

Your WatchGuard Cloud account ID.

createdinteger required

Time that the object was created, specified in Unix epoch time format.

device'firewan' required

Device this object applies to.

authorstring required

Author of the object. This is always empty for objects added or updated with the FireCloud Management API.

action'allow' | 'block' required

Specifies the action to take for the WebBlocker exception, either allow or block.

alarmboolean

Specifies whether the FireCloud sends an alarm for the WebBlocker exception.

namestring required

Specifies the name of the WebBlocker exception. Maximum: 58 characters.

rule_type'string' | 'pattern' | 'regexp' required

Specifies the type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).

rulestring required

Specifies the URL pattern, value, or expression to match. Maximum: 255 characters.

Example request

{
  "version": 1,
  "account": "WGC-1-123abc456",
  "created": 1579907960,
  "device": "firewan",
  "alarm": true,
  "name": "Allow example.com",
  "rule": "www.example.com/*, 1.1.1.1, or (www\\.)?example\\.[com|net]"
}

Response

The updated WebBlocker exception object.

idstring required

Unique ID that identifies this object.

objectstring required

Type of object.

versioninteger required

Version number of the object.

accountstring required

Your WatchGuard Cloud account ID.

createdinteger required

Time that the object was created, specified in Unix epoch time format.

device'firewan' required

Device this object applies to.

authorstring required

Author of the object. This is always empty for objects added or updated with the FireCloud Management API.

action'allow' | 'block' required

Specifies the action to take for the WebBlocker exception, either allow or block.

alarmboolean

Specifies whether the FireCloud sends an alarm for the WebBlocker exception.

namestring required

Specifies the name of the WebBlocker exception. Maximum: 58 characters.

rule_type'string' | 'pattern' | 'regexp' required

Specifies the type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).

rulestring required

Specifies the URL pattern, value, or expression to match. Maximum: 255 characters.

Example response

{
  "id": "wbe_12124_7HM70EvrifZ7rSfXSA",
  "object": "webblocker_exception",
  "device": "firewan",
  "version": 1,
  "account": "WGC-1-123abc456",
  "created": 1579907960,
  "author": "jsmith",
  "name": "Allow www.example.com",
  "rule_type": "string",
  "rule": "www.example.com/*",
  "action": "allow"
}

Changes

No recorded changes to this operation across all 1 revision of this API.