FireCloud Management API

Content-Type

application/json

Accept

application/json

Authorization

The access token that you generate with the WatchGuard Authentication API. For more information, see Authentication.

WatchGuard-API-Key

The API Key associated with your WatchGuard Cloud account (shown on the Managed Access page in WatchGuard Cloud).

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the blocked sites exception. Maximum: 127 characters.

Example: Block example.com.

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

address
object

Address of the site to allow.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

author
string

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

created
integer

Time that the blocked sites exception was created, specified in Unix epoch time format.

Example: 1579907960

version
integer

Version number of the exception.

Example: 1

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the Blocked Sites Exceptions list. FireCloud allows connections to or from addresses on the Blocked Sites Exceptions list. This is the default value.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: example.com

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the blocked sites exception. Maximum: 127 characters.

Example: Block example.com.

address
object

Address of the site to allow.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the Blocked Sites Exceptions list. FireCloud allows connections to or from addresses on the Blocked Sites Exceptions list. This is the default value.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the blocked sites exception. Maximum: 127 characters.

Example: Block example.com.

address
object

Address of the site to allow.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the Blocked Sites Exceptions list. FireCloud allows connections to or from addresses on the Blocked Sites Exceptions list. This is the default value.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: blockedsite_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the blocked sites exception. Maximum: 127 characters.

Example: Block example.com.

address
object

Address of the site to allow.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the Blocked Sites Exceptions list. FireCloud allows connections to or from addresses on the Blocked Sites Exceptions list. This is the default value.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: blockedsite_exception

description
string

Description of the blocked sites exception. Maximum: 127 characters.

Example: Block example.com.

address
object

Address of the site to allow.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the Blocked Sites Exceptions list. FireCloud allows connections to or from addresses on the Blocked Sites Exceptions list. This is the default value.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: botnet_exception

description
string

Description of the botnet site exception. Maximum: 127 characters.

Example: Allow example.com.

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

created
integer

Time that the botnet site exception was created, specified in Unix epoch time format.

Example: 1579907960

author
string

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

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bote_12345_8LBasn0hDNXnli4V0

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: botnet_exception

description
string

Description of the botnet site exception. Maximum: 127 characters.

Example: Allow example.com.

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: botnet_exception

description
string

Description of the botnet site exception. Maximum: 127 characters.

Example: Allow example.com.

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: botnet_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: botnet_exception

description
string

Description of the botnet site exception. Maximum: 127 characters.

Example: Allow example.com.

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: botnet_exception

description
string

Description of the botnet site exception. Maximum: 127 characters.

Example: Allow example.com.

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object

string

Type of exception object.

Example: file_exception

description

string

Description of the file exception. Maximum: 127 characters.

Example: Drop malicious executable

account

string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

md5

string

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

version

integer

Version number of the exception.

Example: 1

device

string

Device this object applies to. The allowed value is firewan.

Example: firewan

created

integer

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

Example: 1579907960

author

string

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

action

string

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

id

string

Unique ID that identifies this exception.

Example: file_12345_n4AeGRHpqPuPGZeu2

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

action
string
REQUIRED

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

md5
string
REQUIRED

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

object
string

Type of exception object.

Example: file_exception

description
string

Description of the file exception. Maximum: 127 characters.

Example: Drop malicious executable

md5
string

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

action
string

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: file_exception

description
string

Description of the file exception. Maximum: 127 characters.

Example: Drop malicious executable

md5
string

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

action
string

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: file_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Drop malicious executable

action
string
REQUIRED

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

md5
string
REQUIRED

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

object
string

Type of exception object.

Example: file_exception

description
string

Description of the file exception. Maximum: 127 characters.

Example: Drop malicious executable

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

md5
string

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

author
string

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

created
integer

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

Example: 1579907960

version
integer

Version number of the exception.

Example: 1

action
string

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

id
string

Unique ID that identifies this exception.

Example: file_12345_n4AeGRHpqPuPGZeu2

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: file_exception

description
string

Description of the file exception. Maximum: 127 characters.

Example: Drop malicious executable

md5
string

MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).

Example: 36f72eb9f68337c44c86be68968ce83c

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

action
string

Action to take for the file. The allowed values are:

• allow — Allows the file. Use this action for files that you always want to allow.
• block — Blocks the file. Use this action for files that you always want to reject.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: geolocation_exception

description
string

Description of the Geolocation exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

author
string

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

created
integer

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

Example: 1579907960

version
integer

Version number of the exception.

Example: 1

id
string

Unique ID that identifies this exception.

Example: geoe_12345_pkPGFCRqE8DRFf6kz

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: geolocation_exception

description
string

Description of the Geolocation exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: geolocation_exception

description
string

Description of the Geolocation exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: geolocation_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow *.example.com

address
object
REQUIRED

Address of the site to allow.

type
string
REQUIRED

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string
REQUIRED

Address of the site to allow. This address format must match the address type, as follows:

• fqdn — Specify a fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — Specify an IPv4 address. Example: 192.0.2.1.
• ipv4_range — Specify a range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — Specify an IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the address. The allowed values are:

• allow — Adds the address to the exceptions list. FireCloud allows connections to or from addresses on the exceptions list. This is the default value.

object
string

Type of exception object.

Example: geolocation_exception

description
string

Description of the Geolocation exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: geolocation_exception

description
string

Description of the Geolocation exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

address
object

Address of the site.

type
string

Type of address. The allowed values are:

• fqdn — A fully qualified domain name.
• ipv4_host — An IPv4 address.
• ipv4_range — An IPv4 address range.
• ipv4_network — An IPv4 network.

value
string

Address of the site. This address format must match the address type, as follows:

• fqdn — Fully qualified domain name. Example: example.com or *.example.com.
• ipv4_host — IPv4 address. Example: 192.0.2.1.
• ipv4_range — Range of IPv4 addresses (two addresses separated by a hyphen). Example: 192.0.2.1-192.0.2.5.
• ipv4_network — IPv4 network. Example: 192.0.2.0/24.

action
string

Action to take for the specified address.

Example: Allow

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: ips_exception

signature_id
string

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the IPS exception. Maximum: 127 characters.

Example: Allow 123456789012345

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception.

Example: true

author
string

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

created
integer

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

Example: 1579907960

version
integer

Version number of the exception.

Example: 1

action
string

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

id
string

Unique ID that identifies this exception.

Example: wbe_12345_G4dywojda1rjAv95J

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

action
string
REQUIRED

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

signature_id
string
REQUIRED

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

object
string

Type of exception object.

Example: ips_exception

signature_id
string

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

description
string

Description of the IPS exception. Maximum: 127 characters.

Example: Allow 123456789012345

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

action
string

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: ips_exception

signature_id
string

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

description
string

Description of the IPS exception. Maximum: 127 characters.

Example: Allow 123456789012345

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

action
string

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: ips_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Drop 123456789012345

action
string
REQUIRED

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

signature_id
string
REQUIRED

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

object
string

Type of exception object.

Example: ips_exception

signature_id
string

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

description
string

Description of the IPS exception. Maximum: 127 characters.

Example: Allow 123456789012345

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

action
string

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: ips_exception

description
string

Description of the IPS exception. Maximum: 127 characters.

Example: Allow 123456789012345

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

signature_id
string

IPS signature ID. Must contain only numbers. Maximum: 31 characters.

IPS signature ID that identifies the signature to allow or block.

You can also look up signature IDs on the WatchGuard Security Portal.

Example: 123456789012345

alarm
boolean

Specifies whether FireCloud sends an alarm for the IPS exception. The default value is false.

Example: true

action
string

Action to take for the specified signature. The allowed values are:

• allow — Allows the connection.
• block — Denies the request, drops the connection, and adds the IP address of the content source to the Blocked Sites list.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

object
string

Type of exception object.

Example: webblocker_exception

name
string

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

created
integer

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

Example: 1579907960

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

rule_type
string

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

version
integer

Version number of the exception.

Example: 1

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

id
string

Unique ID that identifies this exception.

Example: wbe_12345_G4dywojda1rjAv95J

rule
string

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

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

author
string

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

action
string

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

action
string
REQUIRED

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

name
string
REQUIRED

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule_type
string
REQUIRED

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

rule
string
REQUIRED

The URL pattern, value, or regular expression to match. Maximum: 255 characters.

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

object
string

Type of exception object.

Example: webblocker_exception

name
string

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule_type
string

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

rule
string

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

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

action
string

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: webblocker_exception

name
string

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule_type
string

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

rule
string

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

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

action
string

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: webblocker_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

action
string
REQUIRED

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

name
string
REQUIRED

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule_type
string
REQUIRED

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

rule
string
REQUIRED

The URL pattern, value, or regular expression to match. Maximum: 255 characters.

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

object
string

Type of exception object.

Example: webblocker_exception

name
string

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule_type
string

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

rule
string

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

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net].

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

action
string

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

object
string

Type of exception object.

Example: webblocker_exception

name
string

Name of the WebBlocker exception. Letters, numbers, spaces, and -_+.*)( characters, including non-ASCII characters. Maximum: 58 characters.

Example: Allow example.com

rule
string

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

Examples:

www.example.com/*

1.1.1.1

(www\\.)?example\\.[com|net]

Some characters used in regular expressions are reserved by JSON syntax, such as the backslash (\). To include these characters in JSON request data, escape them according to JSON encoding rules. For example, use \\ to represent a single backslash (\).

inactive
boolean

Indicates whether the exception is inactive. The value is always true for deleted exceptions.

Example: true

rule_type
string

The type of rule. The allowed values are:

• string — Matches an exact URL or IP address, character by character. You cannot use wildcards, and you must type each character exactly as you want it to be matched. Example: if you enter an exception to allow www.example.com as an exact match only, and a user types “www.example.com/news”, the request is denied.
• pattern — Matches a pattern in the URL or IP address. Example: “pattern” in www.pattern.com. Make sure to drop the leading “http://” and include “/*" at the end. Use the wildcard symbol, *, to match any character. You can use more than one wildcard in one pattern.
• regexp — Uses a Perl-compatible regular expression to make a match. Example: \.[onc][eor][gtm] matches .org, .net, .com, or any other three-letter combination of one letter from each bracket, in order. When you create a regular expression to match URL paths, do not include the leading “http://”. Regular expressions support wildcards used in shell scripts.

Example: string

alarm
boolean

Specifies whether FireCloud sends an alarm for the WebBlocker exception. The default value is false.

Example: true

action
string

Action to take for the WebBlocker exception, either allow or block. The allowed values are:

• allow — Allows the request. The requested website opens.
• block — Blocks the request. The website does not open.

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

id
string

Unique ID that identifies this exception.

Example: hte_12345_ARBHLJ70Y78rGOIGBS

object
string

Type of exception object.

Example: https_exception

version
integer

Version number of the exception.

Example: 1

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456

created
integer

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

Example: 1579907960

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

author
string

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

Example:

description
string

Description of the HTTPS decryption exception. Maximum: 127 characters.

Example: Allow test.com

rule
string

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x.

Example: test.com

type
string

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

rule
string
REQUIRED

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x. Format depends on the type parameter: FQDN (Example: example.com), IPv4 host (Example: 192.0.2.1), or IPv4 network CIDR (Example: 192.0.2.0/24).

Example: test.com

type
string
REQUIRED

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

description
string

Description of the HTTPS decryption exception. Maximum: 127 characters.

Example: Allow test.com

rule
string

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x. Format depends on the type parameter: FQDN (Example: example.com), IPv4 host (Example: 192.0.2.1), or IPv4 network CIDR (Example: 192.0.2.0/24).

Example: test.com

type
string

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

description
string

Description of the HTTPS decryption exception. Maximum: 127 characters.

Example: Allow test.com

rule
string

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x. Format depends on the type parameter: FQDN (Example: example.com), IPv4 host (Example: 192.0.2.1), or IPv4 network CIDR (Example: 192.0.2.0/24).

Example: test.com

type
string

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

id
string
REQUIRED

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

object
string
REQUIRED

Type of exception object.

Example: https_exception

version
integer
REQUIRED

Version number of the exception to update.

Example: 1

account
string
REQUIRED

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

created
integer
REQUIRED

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

Example: 1579907960

author
string
REQUIRED

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

Example: ""

device
string
REQUIRED

Device this object applies to. The allowed value is firewan.

Example: firewan

description
string

Description of the exception. Maximum: 127 characters.

Example: Allow 192.0.2.1

rule
string
REQUIRED

Address to match for HTTPS decryption.

Example: test.com

type
string
REQUIRED

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

description
string

Description of the HTTPS decryption exception. Maximum: 127 characters.

Example: Allow test.com

rule
string

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x. Format depends on the type parameter: FQDN (Example: example.com), IPv4 host (Example: 192.0.2.1), or IPv4 network CIDR (Example: 192.0.2.0/24).

Example: test.com

type
string

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string

Device this object applies to. The allowed value is firewan.

Example: firewan

version
integer

Version number of the exception.

Example: 1

accountid
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

objectid
string
REQUIRED

Unique ID that identifies the exception in your FireCloud account. The ID prefix varies by exception type.

Example: bse_12345_EU03pOyqJT1m32k23H, file_12345_UqhDVIdx8D5iwivAX, or wbe_12345_G4dywojda1rjAv95J

description
string

Description of the HTTPS decryption exception. Maximum: 127 characters.

Example: Allow test.com

rule
string

Specifies the FQDN or IPv4 address to match for HTTPS decryption. For ipv4_network type, specify an address other than 0.0.0.0/x. Format depends on the type parameter: FQDN (Example: example.com), IPv4 host (Example: 192.0.2.1), or IPv4 network CIDR (Example: 192.0.2.0/24).

Example: test.com

type
string

Rule type. The allowed values are:

• fqdn
• ipv4_host
• ipv4_network

Example: fqdn

action
string

Action to take for the specified rule. The allowed value is allow.

Example: allow

id
string

Unique ID that identifies this exception.

Example: bse_12345_EU03pOyqJT1m32k23H

author
string

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

created
integer

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

Example: 1579907960

account
string

Your WatchGuard Cloud account ID.

Example: WGC-1-123abc456 or ACC-1234567

device
string