Firebox Management API Version History

• You can now add an allocated Firebox to WatchGuard Cloud as a cloud-managed device, including the optional staged request parameter:
  • /{v1}/configuration/{accountid}/devices/timezones
  • /{v1}/configuration/{accountid}/devices/add
    For more information, go to Add a Firebox to WatchGuard Cloud.
• You can now retrieve the device ID for a Firebox by serial number:
  • /{v1}/info/{accountid}/devices/sn/{object_id}
    For more information, go to Retrieve the Device ID for a Firebox by Serial Number.

• Minor updates and bug fixes.

• To create staged deployments for cloud-managed Fireboxes, you can now specify the staged request parameter in this endpoint:
  • /{v1}/commands/{accountid}/deployments

• You can now retrieve device details for Fireboxes, FireClusters, and Access Points:
  • /{v1}/info/{accountid}/devices

• You can now retrieve, subscribe, reorder, and unsubscribe Firebox templates:
  • /{v1}/configuration/{accountid}/templates/subscribe
  • /{v1}/configuration/{accountid}/templates/subscribe

• You can now create and manage Firebox Firewall Policies:
  • /{v1}/configuration/{accountid}/firewall/policies

  • /{v1}/configuration/{accountid}/firewall/policies

  • /{v1}/configuration/{accountid}/firewall/policies/{objectid}

  • /{v1}/configuration/{accountid}/firewall/policies/{objectid}

  • /{v1}/configuration/{accountid}/firewall/policies/{objectid}

  • /{v1}/configuration/{accountid}/firewall/policies/{objectid}

• You can now retrieve the configuration object details that firewall policies reference:
  • /{v1}/configuration/{accountid}/firewall/policy_groups

  • /{v1}/configuration/{accountid}/firewall/policy_groups/{objectid}

  • /{v1}/configuration/{accountid}/firewall/traffic_types

  • /{v1}/configuration/{accountid}/firewall/traffic_types/{objectid}

  • /{v1}/configuration/{accountid}/firewall/aliases

  • /{v1}/configuration/{accountid}/firewall/aliases/{objectid}

  • /{v1}/configuration/{accountid}/networking/networks

  • /{v1}/configuration/{accountid}/networking/networks/{objectid}

  • /{v1}/configuration/{accountid}/authentication/users

  • /{v1}/configuration/{accountid}/authentication/users/{objectid}

  • /{v1}/configuration/{accountid}/authentication/groups

  • /{v1}/configuration/{accountid}/authentication/groups/{objectid}

  • /{v1}/configuration/{accountid}/authentication/auth_groups

  • /{v1}/configuration/{accountid}/authentication/auth_groups/{objectid}

  • /{v1}/configuration/{accountid}/authentication/authpoint_user_groups

  • /{v1}/configuration/{accountid}/authentication/authpoint_user_groups/{objectid}

  • /{v1}/configuration/{accountid}/authentication/saml_user_groups

  • /{v1}/configuration/{accountid}/authentication/saml_user_groups/{objectid}

  • /{v1}/configuration/{accountid}/firewall/snat_actions

  • /{v1}/configuration/{accountid}/firewall/snat_actions/{objectid}

  • /{v1}/configuration/{accountid}/networking/sdwans

  • /{v1}/configuration/{accountid}/networking/sdwans/{objectid}

  • /{v1}/configuration/{accountid}/traffic_shaping/rules

  • /{v1}/configuration/{accountid}/traffic_shaping/rules/{objectid}

  • /{v1}/configuration/{accountid}/system/schedule

  • /{v1}/configuration/{accountid}/system/schedule/{objectid}

  • /{v1}/configuration/{accountid}/content_filtering

  • /{v1}/configuration/{accountid}/content_filtering/{objectid}

• Minor updates and bug fixes.

• You can now create and manage Branch Office VPNs (BOVPN):
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels/{objectid}
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels/{objectid}
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels/{objectid}
  • /{v1}/configuration/{accountid}/bovpn/ipsec/tunnels/{objectid}
  • /{v1}/configuration/{accountid}/bovpn/ipsec/p1_shared_settings
  • /{v1}/configuration/{accountid}/bovpn/ipsec/p1_shared_settings
  • /{v1}/configuration/{accountid}/bovpn/ipsec/p1_shared_settings
• You can now create and manage account certificates and Firebox certificates:
  • /{v1}/configuration/{accountid}/system/certificates
  • /{v1}/command/{accountid}/system/certificates/install
  • /{v1}/configuration/{accountid}/system/certificates/{objectid}
  • /{v1}/configuration/{accountid}/system/certificates
  • /{v1}/configuration/{accountid}/system/certificates/{objectid}

• You can now specify a maximum of 50 devices in requests to enable, disable, and deploy global exceptions for these endpoints:
  • /v1/commands/{accountid}/global_exceptions/enable
  • /v1/commands/{accountid}/global_exceptions/disable
  • /v1/commands/{accountid}/deployments
• API responses are updated for these endpoints:
  • /{v1}/commands/{accountid}/deployments

  • /{v1}/commands/{accountid}/transactions

  • /{v1}/commands/{accountid}/transactions/{objectid}

  • /{v1}/commands/{accountid}/transactions/{objectid}

  • /{v1}/commands/{accountid}/transactions/{objectid}

• The WebBlocker exception name parameter can now include only letters, numbers, spaces, parentheses "()", asterisks "*", periods ".", hyphens "-", and underscores "_".

• The API specification now indicates that the WebBlocker exception name parameter has a maximum length of 58 characters.

• Version 2 of these endpoints include new limit and start_after request parameters to support pagination:
  • /v2/configuration/{accountid}/exceptions
  • /v2/configuration/{accountid}/exceptions/blockedsite
  • /v2/configuration/{accountid}/exceptions/botnet
  • /v2/configuration/{accountid}/exceptions/file
  • /v2/configuration/{accountid}/exceptions/ips
  • /v2/configuration/{accountid}/exceptions/geolocation
  • /v2/configuration/{accountid}/exceptions/webblocker

  Version 1 of these GET endpoints are deprecated but continue to accept requests.

The device and devices request parameters now accept both integers and strings. For standalone Fireboxes, specify only the numbers from the device ID (12345). For FireClusters, specify the full device ID (FBCL-12345).

• New endpoints to retrieve, update, and delete transactions:
  • /{v1}/commands/{accountid}/transactions
  • /{v1}/commands/{accountid}/transactions/{objectid}
  • /{v1}/commands/{accountid}/transactions/{objectid}

  For more information, see Firebox Management API.

• The description request body parameter is no longer required when you create or update an exception.
• The maximum length of the name parameter for WebBlocker exceptions is now 63 characters (reduced from 127 characters). The parameter no longer has any pattern restrictions.
• Updated pattern values in these schemas:
  • ipv4_address_string
  • ipv4_cidr_string
  • ipv4_range_type
  • fqdn_type
  • webblocker_exception_base

• Initial Beta release.