--- title: "Retrieves all exceptions in the specified FireCloud account." method: GET path: "/v1/configuration/{accountid}/exceptions" tags: ["Exceptions"] --- # Retrieves all exceptions in the specified FireCloud account. `GET /v1/configuration/{accountid}/exceptions` ## Request - Base URL: `https://api.usa.cloud.watchguard.com/rest/firecloud/management` - URL: `https://api.usa.cloud.watchguard.com/rest/firecloud/management/v1/configuration/{accountid}/exceptions` - Auth: API key in header `WatchGuard-API-Key` and HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Response `200` A list of all exceptions. - union[] - union - BlockedSiteException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, required: Author of the object. This is always empty for objects added or updated with the FireCloud Management API. - `description` string: Specifies the description of the blocked sites exception. Maximum: 127 characters. - `address` union, required: Address of the site to allow. - union: IPv4 address type. - Ipv4HostType: IPv4 address. - `type` 'ipv4_host', required: Address type identifier. - `value` string, required: IPv4 address string. - Ipv4RangeType: IPv4 address range. - `type` 'ipv4_range', required: Address type identifier. - `value` string, required: IPv4 address range in start-end format. - Ipv4NetworkType: IPv4 network. - `type` 'ipv4_network', required: Address type identifier. - `value` string, required: IPv4 CIDR notation string. - FqdnType: FQDN. - `type` 'fqdn', required: Address type identifier. - `value` string, required: Fully qualified domain name. - `action` 'allow': Action to take for the specified address. - BotnetException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, required: Author of the object. This is always empty for objects added or updated with the FireCloud Management API. - `description` string: Specifies the description of the botnet site exception. Maximum: 127 characters. - `address` union, required: Address of the exception. - union: IPv4 address type. - Ipv4HostType: IPv4 address. - `type` 'ipv4_host', required: Address type identifier. - `value` string, required: IPv4 address string. - Ipv4RangeType: IPv4 address range. - `type` 'ipv4_range', required: Address type identifier. - `value` string, required: IPv4 address range in start-end format. - Ipv4NetworkType: IPv4 network. - `type` 'ipv4_network', required: Address type identifier. - `value` string, required: IPv4 CIDR notation string. - FqdnType: FQDN. - `type` 'fqdn', required: Address type identifier. - `value` string, required: Fully qualified domain name. - `action` 'allow': Action to take for the specified address. - FileException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, 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 specified file, either allow or block. - `description` string: Specifies the description of the file exception. Maximum: 127 characters. - `md5` string, required: Specifies the MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only). - GeolocationException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, required: Author of the object. This is always empty for objects added or updated with the FireCloud Management API. - `description` string: Specifies the description of the Geolocation exception. Maximum: 127 characters. - `address` union, required: Address of the exception. - union: IPv4 address type. - Ipv4HostType: IPv4 address. - `type` 'ipv4_host', required: Address type identifier. - `value` string, required: IPv4 address string. - Ipv4RangeType: IPv4 address range. - `type` 'ipv4_range', required: Address type identifier. - `value` string, required: IPv4 address range in start-end format. - Ipv4NetworkType: IPv4 network. - `type` 'ipv4_network', required: Address type identifier. - `value` string, required: IPv4 CIDR notation string. - FqdnType: FQDN. - `type` 'fqdn', required: Address type identifier. - `value` string, required: Fully qualified domain name. - `action` 'allow': Specifies the action to take for the specified address. - IpsException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, 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 specified signature, either allow or block. - `alarm` boolean: Specifies whether the FireCloud sends an alarm for the IPS exception. - `description` string: Specifies the description of the IPS signature exception. Maximum: 127 characters. - `signature_id` string, required: Specifies the IPS signature ID. Must contain only numbers. Maximum: 31 characters. - WebblockerException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, 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. - `alarm` boolean: Specifies whether the FireCloud sends an alarm for the WebBlocker exception. - `name` string, 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). - `rule` string, required: Specifies the URL pattern, value, or expression to match. Maximum: 255 characters. - HttpsException: Common metadata for all API objects. - `id` string, required: Unique ID that identifies this object. - `object` string, required: Type of object. - `version` integer, required: Version number of the object. - `account` string, required: Your WatchGuard Cloud account ID. - `created` integer, required: Time that the object was created, specified in Unix epoch time format. - `device` 'firewan', required: Device this object applies to. - `author` string, required: Author of the object. This is always empty for objects added or updated with the FireCloud Management API. - `description` string: Specifies the description of the HTTPS decryption exception. Maximum: 127 characters. - `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. - `type` 'fqdn' | 'ipv4_host' | 'ipv4_network', required: Specifies the Rule type, either fqdn, ipv4_host, or ipv4_network. - `action` 'allow': Specifies the action to take for the specified rule. ## Other responses - `403`: ACCESS DENIED - `405`: METHOD NOT ALLOWED - `500`: INTERNAL ERROR --- [API](https://skmtc.dev/watchguard/apis/firecloud-management-api.md) - [All operations](https://skmtc.dev/watchguard/apis/firecloud-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/watchguard/apis/firecloud-management-api/revisions/2c8e3d7b3be2?raw)