openapi: 3.0.0
info:
  title: Firebox Management API
  description: REST API to configure and manage Fireboxes.
  contact:
    name: API Support
    url: https://www.watchguard.com/wgrd-support/contact-support
  version: '1.18.0'
servers:
- url: https://api.usa.cloud.watchguard.com/rest/firebox/management
  description: Prod USA Region
  variables: {}
- url: https://api.deu.cloud.watchguard.com/rest/firebox/management
  description: Prod DEU region
  variables: {}
- url: https://api.jpn.cloud.watchguard.com/rest/firebox/management
  description: Prod JPN region
  variables: {}
paths:
  /v1/configuration/{accountid}/exceptions:
    get:
      tags:
      - Exceptions
      summary: RetrievesexceptionssavedinthespecifiedWatchGuardCloudaccount.
      description: Retrieves exceptions saved in the specified WatchGuard Cloud account.
      operationId: RetrievesexceptionssavedinthespecifiedWatchGuardCloudaccount.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: object:"botnet_exception" AND address.value:"www.example.com"
      responses:
        '200':
          description: A list of all exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1ConfigurationExceptionsResponse'
                description: A list of all exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/blockedsite:
    get:
      tags:
      - Exceptions (Blocked Sites)
      summary: RetrievesblockedsitesexceptionssavedinthespecifiedWatchGuardCloudaccount.
      description: Retrieves blocked sites exceptions saved in the specified WatchGuard Cloud account.
      operationId: RetrievesblockedsitesexceptionssavedinthespecifiedWatchGuardCloudaccount.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which blocked sites exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: action:"block" AND address.type:"ipv4_range"
      responses:
        '200':
          description: A list of blocked sites exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/blocked_site_exception'
                description: A list of blocked sites exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (Blocked Sites)
      summary: Createsanewblockedsitesexception.ThevalueoftheactionparameterspecifieswhethertheFireboxallowsorblockstrafficforthesite.
      description: Creates a new blocked sites exception. The value of the action parameter specifies whether the Firebox allows or blocks traffic for the site.
      operationId: Createsanewblockedsitesexception.ThevalueoftheactionparameterspecifieswhethertheFireboxallowsorblockstrafficforthesite.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/V1ConfigurationExceptionsBlockedsiteRequest'
              - example:
                  device: 12345
                  description: Block example.com
                  address:
                    type: fqdn
                    value: example.com
                  action: block
            example:
              device: 12345
              description: Block example.com
              address:
                type: fqdn
                value: example.com
              action: block
        required: true
      responses:
        '201':
          description: The created blocked sites exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/blocked_site_exception'
                - description: Blocked sites exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/blockedsite/{objectid}:
    get:
      tags:
      - Exceptions (Blocked Sites)
      summary: Retrievesthespecifiedblockedsitesexception.
      description: Retrieves the specified blocked sites exception.
      operationId: Retrievesthespecifiedblockedsitesexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the blocked sites exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: bse_12345_ARBHLJ70Y78rGOIGBS
      responses:
        '200':
          description: The specified blocked sites exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/blocked_site_exception'
                - description: Blocked sites exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (Blocked Sites)
      summary: Updatesthespecifiedblockedsitesexception.
      description: Updates the specified blocked sites exception.
      operationId: Updatesthespecifiedblockedsitesexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the blocked site or blocked sites exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: bse_12345_ARBHLJ70Y78rGOIGBS
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsBlockedsiteRequest1'
        required: true
      responses:
        '201':
          description: The updated blocked sites exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsBlockedsiteResponse'
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (Blocked Sites)
      summary: Deletesthespecifiedblockedsitesexception.
      description: Deletes the specified blocked sites exception.
      operationId: Deletesthespecifiedblockedsitesexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the blocked sites exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: bse_12345_ARBHLJ70Y78rGOIGBS
      responses:
        '201':
          description: The deleted blocked sites exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsBlockedsiteResponse1'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/botnet:
    get:
      tags:
      - Exceptions (Botnet)
      summary: RetrievesbotnetsiteexceptionssavedinthespecifiedWatchGuardCloudaccount.
      description: Retrieves botnet site exceptions saved in the specified WatchGuard Cloud account.
      operationId: RetrievesbotnetsiteexceptionssavedinthespecifiedWatchGuardCloudaccount.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which botnet site exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: device:12345 AND address.type:"ipv4_range"
      responses:
        '200':
          description: A list of botnet site exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/botnet_exception'
                description: A list of botnet site exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (Botnet)
      summary: Createsanewbotnetsiteexception.
      description: Creates a new botnet site exception.
      operationId: Createsanewbotnetsiteexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsBotnetRequest'
        required: true
      responses:
        '201':
          description: The created botnet site exception.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/botnet_exception'
                - description: Botnet site exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/botnet/{objectid}:
    get:
      tags:
      - Exceptions (Botnet)
      summary: Retrievesthespecifiedbotnetsiteexception.
      description: Retrieves the specified botnet site exception.
      operationId: Retrievesthespecifiedbotnetsiteexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the botnet site exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: bote_12345_8LBasn0hDNXnli4V0
      responses:
        '200':
          description: The botnet site exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/botnet_exception'
                - description: Botnet site exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (Botnet)
      summary: Updatesthespecifiedbotnetsiteexception.
      description: Updates the specified botnet site exception.
      operationId: Updatesthespecifiedbotnetsiteexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the botnet site exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: bote_12345_8LBasn0hDNXnli4V0
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsBotnetRequest1'
        required: true
      responses:
        '201':
          description: The updated botnet site exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsBotnetResponse'
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (Botnet)
      summary: Deletesthespecifiedbotnetsiteexception.
      description: Deletes the specified botnet site exception.
      operationId: Deletesthespecifiedbotnetsiteexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the botnet site exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: bote_12345_8LBasn0hDNXnli4V0
      responses:
        '201':
          description: The deleted botnet site exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsBotnetResponse1'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/file:
    get:
      tags:
      - Exceptions (File)
      summary: RetrievesfileexceptionssavedinthespecifiedWatchGuardCloudaccount.
      description: Retrieves file exceptions saved in the specified WatchGuard Cloud account.
      operationId: RetrievesfileexceptionssavedinthespecifiedWatchGuardCloudaccount.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which file exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: device:12345 AND action:"allow"
      responses:
        '200':
          description: A list of file exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/file_exception'
                description: A list of file exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (File)
      summary: Createsanewfileexception.
      description: Creates a new file exception.
      operationId: Createsanewfileexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsFileRequest'
        required: true
      responses:
        '201':
          description: The created file exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/file_exception'
                - description: File exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/file/{objectid}:
    get:
      tags:
      - Exceptions (File)
      summary: Retrievesthespecifiedfileexception.
      description: Retrieves the specified file exception.
      operationId: Retrievesthespecifiedfileexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the file exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: file_12345_UqhDVIdx8D5iwivAX
      responses:
        '200':
          description: The file exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/file_exception'
                - description: File exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (File)
      summary: Updatesthespecifiedfileexception.
      description: Updates the specified file exception.
      operationId: Updatesthespecifiedfileexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the file exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: file_12345_UqhDVIdx8D5iwivAX
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsFileRequest1'
        required: true
      responses:
        '201':
          description: The updated file exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/file_exception'
                - description: File exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (File)
      summary: Deletesthespecifiedfileexception.
      description: Deletes the specified file exception.
      operationId: Deletesthespecifiedfileexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the file exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: file_12345_UqhDVIdx8D5iwivAX
      responses:
        '201':
          description: The deleted file exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsFileResponse'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/geolocation:
    get:
      tags:
      - Exceptions (Geolocation)
      summary: RetrievesallGeolocationexceptionssavedinthespecifiedWatchGuardCloudaccount.
      description: Retrieves all Geolocation exceptions saved in the specified WatchGuard Cloud account.
      operationId: RetrievesallGeolocationexceptionssavedinthespecifiedWatchGuardCloudaccount.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which Geolocation exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: device:12345 AND address.type:"ipv4_range"
      responses:
        '200':
          description: A list of geolocation exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/geolocation_exception'
                description: A list of geolocation exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (Geolocation)
      summary: CreatesanewGeolocationexception.
      description: Creates a new Geolocation exception.
      operationId: CreatesanewGeolocationexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsGeolocationRequest'
        required: true
      responses:
        '201':
          description: The created geolocation exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/geolocation_exception'
                - description: Geolocation exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/geolocation/{objectid}:
    get:
      tags:
      - Exceptions (Geolocation)
      summary: RetrievesthespecifiedGeolocationexception.
      description: Retrieves the specified Geolocation exception.
      operationId: RetrievesthespecifiedGeolocationexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the Geolocation exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: geoe_12345_aHbWC5IuWO3qzyV2t
      responses:
        '200':
          description: The geolocation exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/geolocation_exception'
                - description: Geolocation exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (Geolocation)
      summary: UpdatesthespecifiedGeolocationexception.
      description: Updates the specified Geolocation exception.
      operationId: UpdatesthespecifiedGeolocationexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the Geolocation exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: geoe_12345_aHbWC5IuWO3qzyV2t
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsGeolocationRequest1'
        required: true
      responses:
        '201':
          description: The updated geolocation exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/geolocation_exception'
                - description: Geolocation exception.
                  example:
                    id: geoe_12345_aHbWC5IuWO3qzyV2t
                    object: geolocation_exception
                    version: 2
                    account: WGC-1-123abc456
                    created: 1579907960
                    device: 12345
                    author: testuser
                    description: Allow example.com
                    address:
                      type: fqdn
                      value: example.com
              example:
                id: geoe_12345_aHbWC5IuWO3qzyV2t
                object: geolocation_exception
                version: 2
                account: WGC-1-123abc456
                created: 1579907960
                device: 12345
                author: testuser
                description: Allow example.com
                address:
                  type: fqdn
                  value: example.com
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (Geolocation)
      summary: DeletesthespecifiedGeolocationexception.
      description: Deletes the specified Geolocation exception.
      operationId: DeletesthespecifiedGeolocationexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the Geolocation exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: geoe_12345_aHbWC5IuWO3qzyV2t
      responses:
        '201':
          description: The deleted geolocation exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsGeolocationResponse'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/ips:
    get:
      tags:
      - Exceptions (Intrusion Prevention)
      summary: RetrievesallIPSsignatureexceptions.
      description: Retrieves all IPS signature exceptions.
      operationId: RetrievesallIPSsignatureexceptions.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which IPS signature exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: device:12345 AND signature_id:"1054265"
      responses:
        '200':
          description: A list of IPS signature exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ips_exception'
                description: A list of IPS signature exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (Intrusion Prevention)
      summary: CreatesanewIPSsignatureexception.
      description: Creates a new IPS signature exception.
      operationId: CreatesanewIPSsignatureexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsIpsRequest'
        required: true
      responses:
        '201':
          description: The created IPS signature exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ips_exception'
                - description: IPS signature exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/ips/{objectid}:
    get:
      tags:
      - Exceptions (Intrusion Prevention)
      summary: RetrievesthespecifiedIPSsignatureexception.
      description: Retrieves the specified IPS signature exception.
      operationId: RetrievesthespecifiedIPSsignatureexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the IPS signature exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: ipse_12345_eY5Jwxv1nE3Xlk3zx
      responses:
        '200':
          description: The IPS signature exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ips_exception'
                - description: IPS signature exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (Intrusion Prevention)
      summary: UpdatesthespecifiedIPSsignatureexception.
      description: Updates the specified IPS signature exception.
      operationId: UpdatesthespecifiedIPSsignatureexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the IPS signature exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: ipse_12345_eY5Jwxv1nE3Xlk3zx
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsIpsRequest1'
        required: true
      responses:
        '201':
          description: The updated IPS signature exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ips_exception'
                - description: IPS signature exception.
                  example:
                    id: ipse_12345_eY5Jwxv1nE3Xlk3zx
                    object: ips_exception
                    device: 12345
                    version: 2
                    account: WGC-1-123abc456
                    created: 1579907960
                    author: testuser
                    description: Drop signature 1055124
                    signature_id: '1054265'
                    action: drop
              example:
                id: ipse_12345_eY5Jwxv1nE3Xlk3zx
                object: ips_exception
                device: 12345
                version: 2
                account: WGC-1-123abc456
                created: 1579907960
                author: testuser
                description: Drop signature 1055124
                signature_id: '1054265'
                action: drop
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (Intrusion Prevention)
      summary: DeletesthespecifiedIPSsignatureexception.
      description: Deletes the specified IPS signature exception.
      operationId: DeletesthespecifiedIPSsignatureexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the IPS signature exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: ipse_12345_eY5Jwxv1nE3Xlk3zx
      responses:
        '201':
          description: The deleted IPS signature exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsIpsResponse'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/webblocker:
    get:
      tags:
      - Exceptions (WebBlocker)
      summary: RetrievesallWebBlockerexceptions.
      description: Retrieves all WebBlocker exceptions.
      operationId: RetrievesallWebBlockerexceptions.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: query
        in: query
        description: Query string that specifies which WebBlocker exceptions to retrieve from WatchGuard Cloud, written in Lucene query syntax.
        style: form
        explode: true
        schema:
          type: string
          example: device:12345 AND rule_type:"string"
      responses:
        '200':
          description: A list of WebBlocker exceptions.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webblocker_exception'
                description: A list of WebBlocker exceptions.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    post:
      tags:
      - Exceptions (WebBlocker)
      summary: CreatesanewWebBlockerexception.
      description: Creates a new WebBlocker exception.
      operationId: CreatesanewWebBlockerexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsWebblockerRequest'
        required: true
      responses:
        '201':
          description: The created WebBlocker exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webblocker_exception'
                - description: WebBlocker exception.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/configuration/{accountid}/exceptions/webblocker/{objectid}:
    get:
      tags:
      - Exceptions (WebBlocker)
      summary: RetrievesthespecifiedWebBlockerexception.
      description: Retrieves the specified WebBlocker exception.
      operationId: RetrievesthespecifiedWebBlockerexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the WebBlocker exception to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: wbe_12124_7HM70EvrifZ7rSfXSA
      responses:
        '200':
          description: The WebBlocker exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webblocker_exception'
                - description: WebBlocker exception.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Exceptions (WebBlocker)
      summary: UpdatesthespecifiedWebBlockerexception.
      description: Updates the specified WebBlocker exception.
      operationId: UpdatesthespecifiedWebBlockerexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the WebBlocker exception to update in your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: wbe_12124_7HM70EvrifZ7rSfXSA
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1ConfigurationExceptionsWebblockerRequest1'
        required: true
      responses:
        '201':
          description: The updated WebBlocker exception object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webblocker_exception'
                - description: WebBlocker exception.
                  example:
                    id: wbe_12124_7HM70EvrifZ7rSfXSA
                    object: webblocker_exception
                    device: 12345
                    version: 2
                    account: WGC-1-123abc456
                    created: 1579907960
                    author: testuser
                    name: Allow www.example.com
                    rule_type: string
                    rule: www.example.com/*
                    action: allow
              example:
                id: wbe_12124_7HM70EvrifZ7rSfXSA
                object: webblocker_exception
                device: 12345
                version: 2
                account: WGC-1-123abc456
                created: 1579907960
                author: testuser
                name: Allow www.example.com
                rule_type: string
                rule: www.example.com/*
                action: allow
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '409':
          description: CONFLICT
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Exceptions (WebBlocker)
      summary: DeletesthespecifiedWebBlockerexception.
      description: Deletes the specified WebBlocker exception.
      operationId: DeletesthespecifiedWebBlockerexception.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the WebBlocker exception to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: wbe_12124_7HM70EvrifZ7rSfXSA
      responses:
        '201':
          description: The deleted WebBlocker exception object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConfigurationExceptionsWebblockerResponse'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/commands/{accountid}/global_exceptions/enable:
    post:
      tags:
      - Global Exceptions
      summary: EnablestheabilitytomanageanddeployexceptionswiththeFireboxManagementAPIforthespecifieddevice(s).
      description: Enables the ability to manage and deploy exceptions with the Firebox Management API for the specified device(s).
      operationId: EnablestheabilitytomanageanddeployexceptionswiththeFireboxManagementAPIforthespecifieddevice(s).
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CommandsGlobalExceptionsEnableRequest'
        required: true
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/commands/{accountid}/global_exceptions/disable:
    post:
      tags:
      - Global Exceptions
      summary: DisablestheabilitytomanageanddeployglobalexceptionswiththeFireboxManagementAPIforthespecifieddevice(s).Youcanspecifywhethertoretainordeleteexceptionsonthedevice(s).
      description: Disables the ability to manage and deploy global exceptions with the Firebox Management API for the specified device(s). You can specify whether to retain or delete exceptions on the device(s).
      operationId: DisablestheabilitytomanageanddeployglobalexceptionswiththeFireboxManagementAPIforthespecifieddevice(s).Youcanspecifywhethertoretainordeleteexceptionsonthedevice(s).
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CommandsGlobalExceptionsDisableRequest'
        required: true
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/commands/{accountid}/deployments:
    post:
      tags:
      - Deployments
      summary: DeploysexceptionssavedinWatchGuardCloudtothespecifieddevices.
      description: Deploys exceptions saved in WatchGuard Cloud to the specified devices.
      operationId: DeploysexceptionssavedinWatchGuardCloudtothespecifieddevices.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/V1CommandsDeploymentsRequest'
              - example:
                  devices:
                  - 12345
                  - 12346
                  - 12347
                  start_date: 2020-04-19T21:23:46Z
                  description: Deploy objects to Seattle office Fireboxes.
            example:
              devices:
              - 12345
              - 12346
              - 12347
              start_date: 2020-04-19T21:23:46Z
              description: Deploy objects to Seattle office Fireboxes.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_transaction'
                description: Created
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/commands/{accountid}/transactions:
    get:
      tags:
      - Deployments
      summary: Retrievesalistoftransactionrecords,whichincludedetailsofindividualdeployments.
      description: Retrieves a list of transaction records, which include details of individual deployments.
      operationId: Retrievesalistoftransactionrecords,whichincludedetailsofindividualdeployments.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: device
        in: query
        description: Specifies the ID of the device to retrieve transaction records for.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          example: 12345
      - name: tx_type
        in: query
        description: Specifies the type of transaction records to retrieve.
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/tx_type'
          - description: Specifies the type of transaction records to retrieve.
      responses:
        '200':
          description: The transaction objects.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_transaction'
                description: The transaction objects.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /v1/commands/{accountid}/transactions/{objectid}:
    get:
      tags:
      - Deployments
      summary: Retrievesthespecifiedtransactionrecord,whichincludesdetailsofaspecificdeployment.
      description: Retrieves the specified transaction record, which includes details of a specific deployment.
      operationId: Retrievesthespecifiedtransactionrecord,whichincludesdetailsofaspecificdeployment.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the transaction record to retrieve.
        required: true
        style: simple
        schema:
          type: string
          example: deployment_12345_1582590305_d76EACA7C8FFIMBmkOzjvT18
      responses:
        '200':
          description: The transaction object.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_transaction'
                description: The transaction object.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    put:
      tags:
      - Deployments
      summary: Updatesthespecifiedtransactionrecord.
      description: Updates the specified transaction record.
      operationId: Updatesthespecifiedtransactionrecord.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the transaction record to update.
        required: true
        style: simple
        schema:
          type: string
          example: deployment_12345_1582590305_d76EACA7C8FFIMBmkOzjvT18
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CommandsTransactionsRequest'
        required: true
      responses:
        '200':
          description: The updated transaction object.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_transaction'
                description: The updated transaction object.
        '400':
          description: BAD REQUEST
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
    delete:
      tags:
      - Deployments
      summary: Deletesthespecifiedtransactionrecord.
      description: Deletes the specified transaction record.
      operationId: Deletesthespecifiedtransactionrecord.
      parameters:
      - name: accountid
        in: path
        description: Your WatchGuard Cloud account ID.
        required: true
        style: simple
        schema:
          type: string
          example: WGC-1-123abc456
      - name: objectid
        in: path
        description: ID of the transaction record to delete from your WatchGuard Cloud account.
        required: true
        style: simple
        schema:
          type: string
          example: deployment_12345_1582590305_d76EACA7C8FFIMBmkOzjvT18
      responses:
        '200':
          description: The deleted transaction object.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/device_transaction'
                description: The deleted transaction object.
        '403':
          description: ACCESS DENIED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: NOT FOUND
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '405':
          description: METHOD NOT ALLOWED
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: INTERNAL ERROR
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      deprecated: false
  /health:
    get:
      summary: Health_GET
      description: HealthCheck URL
      operationId: Health_GET
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
      deprecated: false
components:
  schemas:
    Health:
      title: Health
      type: object
      properties:
        healthy:
          type: boolean
          default: false
    error_response:
      title: error_response
      required:
      - type
      - message
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/Type'
          - description: Type of error.
        message:
          type: string
          description: Error message text.
    ipv4_host_type:
      title: ipv4_host_type
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          example: ipv4_host
        value:
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 192.0.2.1
      description: IPv4 address
    ipv4_network_type:
      title: ipv4_network_type
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          example: ipv4_network
        value:
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/([1-9]|[1-2][0-9]|3[0-2])$
          type: string
          example: 192.0.2.0/24
      description: IPv4 network
    ipv4_range_type:
      title: ipv4_range_type
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          example: ipv4_range
        value:
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)-(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 192.0.2.1-192.0.2.5
      description: IPv4 address range
    fqdn_type:
      title: fqdn_type
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          example: fqdn
        value:
          pattern: ^(\*\.)?([a-zA-Z0-9_](([a-zA-Z0-9_-])*[a-zA-Z0-9_])?\.)+([a-zA-Z])+$
          type: string
          example: example.com
      description: FQDN
    object_metadata:
      title: object_metadata
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
    new_object_attributes:
      title: new_object_attributes
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
    object_update_attributes:
      title: object_update_attributes
      required:
      - version
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
    blocked_site_exception_base:
      title: blocked_site_exception_base
      required:
      - address
      type: object
      properties:
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
    blocked_site_exception:
      title: blocked_site_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
      description: Blocked sites exception.
      example:
        id: bse_12345_ARBHLJ70Y78rGOIGBS
        object: blockedsite_exception
        version: 1
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Block example.com
        address:
          type: fqdn
          value: example.com
        action: block
    botnet_exception_base:
      title: botnet_exception_base
      required:
      - address
      type: object
      properties:
        description:
          maxLength: 127
          type: string
          description: 'Description of the botnet site exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
    botnet_exception:
      title: botnet_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the botnet site exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      description: Botnet site exception.
    file_exception_base:
      title: file_exception_base
      required:
      - action
      - md5
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/Action1'
          - description: Action to take for the specified file, either allow or drop.
        description:
          maxLength: 127
          type: string
          description: 'Description of the file exception. Maximum: 127 characters.'
          example: Allow Sales Presentation.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
    file_exception:
      title: file_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - md5
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action1'
          - description: Action to take for the specified file, either allow or drop.
        description:
          maxLength: 127
          type: string
          description: 'Description of the file exception. Maximum: 127 characters.'
          example: Allow Sales Presentation.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
      description: File exception.
    geolocation_exception_base:
      title: geolocation_exception_base
      required:
      - address
      type: object
      properties:
        description:
          maxLength: 127
          type: string
          description: 'Description of the Geolocation exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
    geolocation_exception:
      title: geolocation_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the Geolocation exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      description: Geolocation exception.
    ips_exception_base:
      title: ips_exception_base
      required:
      - action
      - signature_id
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/Action2'
          - description: Action to take for the specified signature, either allow, block, or drop.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        description:
          maxLength: 127
          type: string
          description: 'Description of the IPS signature exception. Maximum: 127 characters.'
          example: Drop signature 1055124
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
    ips_exception:
      title: ips_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - signature_id
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action2'
          - description: Action to take for the specified signature, either allow, block, or drop.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        description:
          maxLength: 127
          type: string
          description: 'Description of the IPS signature exception. Maximum: 127 characters.'
          example: Drop signature 1055124
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
      description: IPS signature exception.
    webblocker_exception_base:
      title: webblocker_exception_base
      required:
      - action
      - name
      - rule_type
      - rule
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/Action3'
          - description: Action to take for the WebBlocker exception, either allow or deny.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the WebBlocker exception.
          default: false
          example: true
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
    webblocker_exception:
      title: webblocker_exception
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - name
      - rule_type
      - rule
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action3'
          - description: Action to take for the WebBlocker exception, either allow or deny.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the WebBlocker exception.
          default: false
          example: true
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
      description: WebBlocker exception.
    device_transaction:
      title: device_transaction
      required:
      - id
      - type
      - device
      - created
      - start_date
      - status
      - account
      - parent
      - children
      - data
      - operator
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this device transaction.
          example: deployment_12345_1582314499_zRmCUMqFghS5oCLmRcWtshBI
        type:
          type: string
          description: Device transaction type.
          example: deployment
        device:
          type: array
          items:
            type: integer
            format: int32
          description: Device this transaction applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page.
        created:
          type: string
          description: Time that the transaction was created, in UTC format.
          example: 2020-02-21T19:48:19Z
        start_date:
          type: string
          description: Time to deploy the transaction to the device, in UTC format.
          example: 2020-02-21T19:48:19Z
        status:
          allOf:
          - $ref: '#/components/schemas/Status'
          - description: Status of the transaction.
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        parent:
          type: string
          description: ID of the parent transaction of this transaction. The value is null if this transaction does not have a parent transaction.
        children:
          type: array
          items:
            type: string
          description: IDs of the child transactions of this transaction.
        data:
          type: string
          description: Data sent to the device in this transaction. JSON format.
        operator:
          type: string
          description: Operator that added the transaction. This is always empty for transactions added with the Firebox Management API.
      example:
        account: WGC-1-123abc456
        operator: 'null'
        children: []
        device:
        - 12345
        id: deployment_12345_1583348088_es9qbbewaPWAMPrv34wTlVCE
        status: complete
        start_date: '"2020-03-04T18:54:48Z"'
        data: '{\"version\": 1, \"deployment_type\": \"whitelist\", \"description\": \"Deploy exceptions to Seattle office\", \"configs\": [{\"object\": \"botnet_exception\", \"version\": 1, \"created\": 1582751451, \"id\": \"bote_12124_8LBasn0hDNXnli4V0\", \"description\": \"Allow 192.0.2.1.com\", \"author\": \"\", \"account\": \"WGC-1-91b06fbe0a1246dab718\", \"address\": {\"value\": \"192.0.2.1\", \"type\": \"ipv4_host\"}, \"device\": 12124}], \"global_except_enabled\": true, \"deployment_format\": \"json\", \"fccm_enabled\": false}'
        type: deployment
        parent: 'null'
        start_date_epoch: 1583348088
        created: '"2020-03-04T18:54:48Z"'
    Action:
      title: Action
      enum:
      - allow
      - block
      type: string
      description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
    Action1:
      title: Action1
      enum:
      - allow
      - drop
      type: string
      description: Action to take for the specified file, either allow or drop.
    Action2:
      title: Action2
      enum:
      - allow
      - block
      - drop
      type: string
      description: Action to take for the specified signature, either allow, block, or drop.
    Action3:
      title: Action3
      enum:
      - allow
      - deny
      type: string
      description: Action to take for the WebBlocker exception, either allow or deny.
    Address:
      title: Address
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          example: ipv4_host
        value:
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 192.0.2.1
      description: Address of the site to allow or block.
    RuleType:
      title: RuleType
      enum:
      - string
      - pattern
      - regexp
      type: string
      description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
    Status:
      title: Status
      enum:
      - scheduled
      - pending
      - in_progress
      - complete
      - failed
      - timed_out
      type: string
      description: Status of the transaction.
    tx_type:
      title: tx_type
      enum:
      - deployment
      type: string
    Type:
      title: Type
      enum:
      - invalid_request_error
      - access_denied_error
      - invalid_object_error
      - method_denied_error
      - object_exists_error
      - server_error
      type: string
      description: Type of error.
    V1CommandsDeploymentsRequest:
      title: V1CommandsDeploymentsRequest
      required:
      - devices
      - start_date
      type: object
      properties:
        devices:
          type: array
          items:
            type: integer
            format: int32
          description: Device(s) to deploy exceptions to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page. Enclose in square brackets and separate device IDs with commas.
        version:
          type: integer
          description: Version number of the device deployment to deploy. Only specify a version if you want to redeploy a previous deployment to the device.
          format: int32
          example: 1
        start_date:
          maxLength: 128
          minLength: 1
          type: string
          description: Time to deploy objects to the specified devices. Specify 'now' to deploy immediately or specify a time in UTC format to deploy at that time.
          example: 2020-04-19T21:23:46Z
        description:
          maxLength: 128
          minLength: 1
          type: string
          description: 'Description of the device deployment. Maximum: 128 characters.'
          example: Deploy objects to Seattle office Fireboxes.
    V1CommandsGlobalExceptionsDisableRequest:
      title: V1CommandsGlobalExceptionsDisableRequest
      required:
      - devices
      type: object
      properties:
        devices:
          type: array
          items:
            type: integer
            format: int32
          description: Device(s) to disable global exceptions for. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page.
        retain_device_configuration:
          type: boolean
          description: Specifies whether to retain or delete exceptions on the specified device(s) when you disable global exceptions. Either true (retain exceptions) or false (delete exceptions).
          default: false
    V1CommandsGlobalExceptionsEnableRequest:
      title: V1CommandsGlobalExceptionsEnableRequest
      required:
      - devices
      type: object
      properties:
        devices:
          type: array
          items:
            type: integer
            format: int32
          description: Device(s) to enable global exceptions for. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page.
    V1CommandsTransactionsRequest:
      title: V1CommandsTransactionsRequest
      required:
      - start_date
      type: object
      properties:
        start_date:
          maxLength: 128
          minLength: 1
          type: string
          description: Time to deploy objects to the specified devices. Specify 'now' to deploy immediately or specify a time in UTC format to deploy at that time.
          example: 2020-04-19T21:23:46Z
        description:
          maxLength: 128
          minLength: 1
          type: string
          description: 'Description of the device deployment. Maximum: 128 characters.'
          example: Deploy objects to Seattle office Fireboxes.
      example:
        start_date: 2020-04-19T21:23:46Z
        description: Deploy objects to Seattle office Fireboxes.
    V1ConfigurationExceptionsBlockedsiteRequest:
      title: V1ConfigurationExceptionsBlockedsiteRequest
      required:
      - address
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
    V1ConfigurationExceptionsBlockedsiteResponse:
      title: V1ConfigurationExceptionsBlockedsiteResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
      example:
        id: bse_12345_ARBHLJ70Y78rGOIGBS
        object: blockedsite_exception
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Block example.com
        address:
          type: fqdn
          value: example.com
        action: block
    V1ConfigurationExceptionsBotnetRequest:
      title: V1ConfigurationExceptionsBotnetRequest
      required:
      - address
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        description:
          maxLength: 127
          type: string
          description: 'Description of the botnet site exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      example:
        device: 12345
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
    V1ConfigurationExceptionsBotnetResponse:
      title: V1ConfigurationExceptionsBotnetResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
      example:
        id: bote_12345_8LBasn0hDNXnli4V0
        object: botnet_exception
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
    V1ConfigurationExceptionsFileRequest:
      title: V1ConfigurationExceptionsFileRequest
      required:
      - action
      - md5
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        action:
          allOf:
          - $ref: '#/components/schemas/Action1'
          - description: Action to take for the specified file, either allow or drop.
        description:
          maxLength: 127
          type: string
          description: 'Description of the file exception. Maximum: 127 characters.'
          example: Allow Sales Presentation.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
      example:
        device: 12345
        description: Allow Sales Presentation.
        md5: d2ffd57b48ee2ac34a4797ea44571a05
        action: allow
    V1ConfigurationExceptionsFileResponse:
      title: V1ConfigurationExceptionsFileResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - md5
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action1'
          - description: Action to take for the specified file, either allow or drop.
        description:
          maxLength: 127
          type: string
          description: 'Description of the file exception. Maximum: 127 characters.'
          example: Allow Sales Presentation.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
    V1ConfigurationExceptionsGeolocationRequest:
      title: V1ConfigurationExceptionsGeolocationRequest
      required:
      - address
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        description:
          maxLength: 127
          type: string
          description: 'Description of the Geolocation exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      example:
        device: 12345
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
    V1ConfigurationExceptionsGeolocationResponse:
      title: V1ConfigurationExceptionsGeolocationResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the Geolocation exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
      example:
        id: geoe_12345_aHbWC5IuWO3qzyV2t
        object: geolocation_exception
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
        inactive: true
    V1ConfigurationExceptionsIpsRequest:
      title: V1ConfigurationExceptionsIpsRequest
      required:
      - action
      - signature_id
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        action:
          allOf:
          - $ref: '#/components/schemas/Action2'
          - description: Action to take for the specified signature, either allow, block, or drop.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        description:
          maxLength: 127
          type: string
          description: 'Description of the IPS signature exception. Maximum: 127 characters.'
          example: Drop signature 1055124
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
      example:
        device: 12345
        description: Drop signature 1055124
        signature_id: '1054265'
        action: drop
    V1ConfigurationExceptionsIpsResponse:
      title: V1ConfigurationExceptionsIpsResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - signature_id
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action2'
          - description: Action to take for the specified signature, either allow, block, or drop.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        description:
          maxLength: 127
          type: string
          description: 'Description of the IPS signature exception. Maximum: 127 characters.'
          example: Drop signature 1055124
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
      example:
        id: ipse_12345_eY5Jwxv1nE3Xlk3zx
        object: ips_exception
        device: 12345
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        author: testuser
        description: Drop signature 1055124
        signature_id: '1054265'
        action: drop
        inactive: true
    V1ConfigurationExceptionsResponse:
      title: V1ConfigurationExceptionsResponse
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          allOf:
          - $ref: '#/components/schemas/Address'
          - description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
    V1ConfigurationExceptionsWebblockerRequest:
      title: V1ConfigurationExceptionsWebblockerRequest
      required:
      - action
      - name
      - rule_type
      - rule
      type: object
      properties:
        device:
          type: integer
          description: Device this object applies to. Each device has a unique ID number in WatchGuard Cloud, which appears in the URL of the Device Summary page for the device.
          format: int32
          example: 12345
        action:
          allOf:
          - $ref: '#/components/schemas/Action3'
          - description: Action to take for the WebBlocker exception, either allow or deny.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the WebBlocker exception.
          default: false
          example: true
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
      example:
        device: 12345
        name: Allow www.example.com
        rule_type: string
        rule: www.example.com/*
        action: allow
    V1ConfigurationExceptionsWebblockerResponse:
      title: V1ConfigurationExceptionsWebblockerResponse
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - action
      - name
      - rule_type
      - rule
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        action:
          allOf:
          - $ref: '#/components/schemas/Action3'
          - description: Action to take for the WebBlocker exception, either allow or deny.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the WebBlocker exception.
          default: false
          example: true
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
      example:
        id: wbe_12124_7HM70EvrifZ7rSfXSA
        object: webblocker_exception
        device: 12345
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        author: testuser
        name: Allow www.example.com
        rule_type: string
        rule: www.example.com/*
        action: allow
        inactive: true
    V1ConfigurationExceptionsBlockedsiteRequest1:
      title: V1ConfigurationExceptionsBlockedsiteRequest1
      required:
      - version
      - address
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
      example:
        version: 1
        description: Block example.com
        address:
          type: fqdn
          value: example.com
        action: block
    V1ConfigurationExceptionsBlockedsiteResponse1:
      title: V1ConfigurationExceptionsBlockedsiteResponse1
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
      example:
        id: bse_12345_ARBHLJ70Y78rGOIGBS
        object: blockedsite_exception
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Block example.com
        address:
          type: fqdn
          value: example.com
        action: block
        inactive: true
    V1ConfigurationExceptionsBotnetRequest1:
      title: V1ConfigurationExceptionsBotnetRequest1
      required:
      - version
      - address
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        description:
          maxLength: 127
          type: string
          description: 'Description of the botnet site exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      example:
        version: 1
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
    V1ConfigurationExceptionsBotnetResponse1:
      title: V1ConfigurationExceptionsBotnetResponse1
      required:
      - id
      - object
      - version
      - account
      - created
      - author
      - address
      - inactive
      type: object
      properties:
        id:
          type: string
          description: Unique ID that identifies this object.
        object:
          type: string
          description: Type of object.
        version:
          type: integer
          description: Version number of the object.
          format: int32
          example: 1
        account:
          type: string
          description: Your WatchGuard Cloud account ID.
          example: WGC-1-123abc456
        created:
          type: integer
          description: Time that the object was created, specified in Unix epoch time format.
          format: int32
          example: 1579907960
        device:
          type: integer
          description: Device this object applies to.
          format: int32
          example: 12345
        author:
          type: string
          description: Author of the object.  This is always empty for objects added or updated with the Firebox Management API.
        description:
          maxLength: 127
          type: string
          description: 'Description of the blocked sites exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Block example.com
        address:
          type: object
          description: Address of the site to allow or block.
        action:
          allOf:
          - $ref: '#/components/schemas/Action'
          - description: Action to take for the specified address, either allow or block. Allow adds the address to the Blocked Sites Exception list. Block adds the address to the Blocked Sites list.
        inactive:
          type: boolean
          description: Object is inactive.
          example: true
      example:
        id: bote_12345_8LBasn0hDNXnli4V0
        object: botnet_exception
        version: 2
        account: WGC-1-123abc456
        created: 1579907960
        device: 12345
        author: testuser
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
        inactive: true
    V1ConfigurationExceptionsFileRequest1:
      title: V1ConfigurationExceptionsFileRequest1
      required:
      - version
      - action
      - md5
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        action:
          allOf:
          - $ref: '#/components/schemas/Action1'
          - description: Action to take for the specified file, either allow or drop.
        description:
          maxLength: 127
          type: string
          description: 'Description of the file exception. Maximum: 127 characters.'
          example: Allow Sales Presentation.
        md5:
          pattern: ^[a-f0-9]{32}$
          type: string
          description: MD5 hash of the file. Must be 32 characters (lowercase letters a-f and numbers only).
          example: d2ffd57b48ee2ac34a4797ea44571a05
      example:
        version: 1
        description: Allow Sales Presentation.
        md5: d2ffd57b48ee2ac34a4797ea44571a05
        action: allow
    V1ConfigurationExceptionsGeolocationRequest1:
      title: V1ConfigurationExceptionsGeolocationRequest1
      required:
      - version
      - address
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        description:
          maxLength: 127
          type: string
          description: 'Description of the Geolocation exception. Letters, numbers, spaces, commas, and (-_+.*:@/;) only. Maximum: 127 characters.'
          example: Allow example.com
        address:
          type: object
          description: Address of the exception.
      example:
        version: 1
        description: Allow example.com
        address:
          type: fqdn
          value: example.com
    V1ConfigurationExceptionsIpsRequest1:
      title: V1ConfigurationExceptionsIpsRequest1
      required:
      - version
      - action
      - signature_id
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        action:
          allOf:
          - $ref: '#/components/schemas/Action2'
          - description: Action to take for the specified signature, either allow, block, or drop.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the IPS exception.
          default: false
          example: true
        description:
          maxLength: 127
          type: string
          description: 'Description of the IPS signature exception. Maximum: 127 characters.'
          example: Drop signature 1055124
        signature_id:
          pattern: ^[0-9]{1,31}$
          type: string
          description: 'IPS signature ID. Must contain only numbers. Maximum: 31 characters.'
          example: '1055124'
      example:
        version: 1
        description: Drop signature 1055124
        signature_id: '1054265'
        action: drop
    V1ConfigurationExceptionsWebblockerRequest1:
      title: V1ConfigurationExceptionsWebblockerRequest1
      required:
      - version
      - action
      - name
      - rule_type
      - rule
      type: object
      properties:
        version:
          type: integer
          description: Version number of the object to update.
          format: int32
          example: 1
        action:
          allOf:
          - $ref: '#/components/schemas/Action3'
          - description: Action to take for the WebBlocker exception, either allow or deny.
        alarm:
          type: boolean
          description: Specifies whether the Firebox sends an alarm for the WebBlocker exception.
          default: false
          example: true
        name:
          maxLength: 63
          type: string
          description: 'Name of the WebBlocker exception. Maximum: 63 characters.'
          example: Allow example.com
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleType'
          - description: The type of rule, either string (exact match), pattern (pattern match), or regexp (regular expression).
        rule:
          maxLength: 255
          pattern: ^(?=.*\S).+$
          type: string
          description: 'The URL pattern, value, or expression to match. Maximum: 255 characters.'
          example: www.example.com/*, 1.1.1.1, or (www\.)?example\.[com|net]
      example:
        version: 1
        name: Allow www.example.com
        rule_type: string
        rule: www.example.com/*
        action: allow
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: jwt
security:
- jwt: []
tags:
- name: Exceptions
  description: All exception types
- name: Exceptions (Blocked Sites)
  description: The Blocked Sites list specifies sites that cannot make a connection through the Firebox. The Firebox does not block traffic from sites you add to the Blocked Sites Exception list.
- name: Exceptions (Botnet)
  description: Botnet site exceptions specify sites that you do not want to block, even if they are known botnet sites that the Botnet Detection service added to the Blocked SItes list.
- name: Exceptions (File)
  description: File exceptions identify files that you do not want the Firebox to scan with APT Blocker, Data Loss Prevention, Gateway AntiVirus, and IntelligentAV.
- name: Exceptions (Geolocation)
  description: Geolocation exceptions identify sites that you do not want the Geolocation service to block.
- name: Exceptions (Intrusion Prevention)
  description: IPS signature exceptions specify IPS signature IDs that you do not want the Firebox to use to block connections.
- name: Exceptions (WebBlocker)
  description: WebBlocker exceptions specify that WebBlocker must always allow or always deny access to a website, regardless of the WebBlocker content category.
- name: Global Exceptions
  description: Before you can deploy the exceptions you configure with the Firebox Management API to a device, you must enable global exceptions on the device.
- name: Deployments
  description: After you configure exceptions with the Firebox Management API, you can deploy the exceptions to devices immediately or at a specified time.
externalDocs:
  description: Additional documentation
  url: https://www.watchguard.com/help/docs/api/Content/en-US/home.html
