Firebox Management API

Introduction

The Firebox Management API is a RESTful API that you can use to manage and configure Fireboxes that are associated with your WatchGuard Cloud account.

You can use the Firebox Management API to:

You can use the Firebox Management API to manage only Fireboxes in your WatchGuard Cloud account that run Fireware v12.5.3 or higher. To use the BOVPN and Certificate APIs with a cloud-managed Firebox, the device must run Fireware v12.5.7 or higher, To add a Firebox to your WatchGuard Cloud account, follow the steps in Add a Firebox to WatchGuard Cloud.

This API documentation explains how to access the Firebox Management API and includes examples to help you get started.

Get Started

This section describes how to submit requests to the Firebox Management API.

The Firebox Management API URL is:

https://{base API URL}/rest/firebox/management/

The base URL for WatchGuard public APIs varies by region. The base API URL for your account appears on the Managed Access page in WatchGuard Cloud.

Endpoint Path Parameters

Each WatchGuard public API has a version, expressed as <major>.<minor>.<patch>. You specify the major API version, such as v1, as part of the endpoint URI path.

All Firebox Management API endpoint URIs must include your WatchGuard Cloud account ID in the {accountid} path parameter.

Authentication

WatchGuard public APIs use the Open Authorization (OAuth) 2.0 authorization framework for token-based authentication. To use the Firebox Management API, you must first enable API access in your WatchGuard Cloud account and make an API request to generate an access token.

You must include the access token and your API Key in the header of each request you make to the Firebox Management API.

For more information, see Authentication.

Request Headers

You must include this information in the header of each request you make to the Firebox Management API:

Content-Type	application/json
Accept	application/json
Authorization	The access token that you generate with the WatchGuard Authentication API. For more information, see Authentication.
WatchGuard-API-Key	The API Key associated with your WatchGuard Cloud account (shown on the Managed Access page in WatchGuard Cloud).

Pagination

Some GET endpoints that return a list of objects support pagination through the limit and start_after request parameters:

limit
integer

Specifies the maximum number of objects to return in the response.

Example: 10

start_after
string

Specifies the ID of the first exception to return in the response.

Example: wbe_12124_7HM70EvrifZ7rSfXSA

You can use these parameters to construct queries for pages of results.

Exceptions

Exceptions are rules that bypass or override the other settings defined in your Firebox configuration. For example, you might define an exception because you do not want the Firebox to deny access to your company website. Or you might want the Firebox to always allow your users to download a specific file.

For detailed information about this API, go to Firebox Exceptions API.

Branch Office VPNs (BOVPNs)

A Branch Office Virtual Private Network (BOVPN) enables secure, encrypted connections between networks at geographically separated locations. You can configure an IPSec BOVPN tunnel between cloud-managed Fireboxes in your WatchGuard Cloud account or from a cloud-managed Firebox to any other Firebox or third-party VPN endpoint.

For detailed information about this API, go to Branch Office VPNs (BOVPNs) API.

Certificates for Cloud-Managed Fireboxes

You can manage your account certificates and Firebox certificates for cloud-managed devices in WatchGuard Cloud.

For detailed information about this API, go to Certificates For Cloud-Managed Fireboxes API.

Firewall Policies

Firewall policies control which traffic the Firebox allows or denies between networks. The Firebox matches each connection to a policy based on the traffic source, destination, and traffic type.

For detailed information about this API, go to Firewall Policies API.

Deployments

To update a device with the configuration changes saved in your WatchGuard Cloud account, you must create a deployment for the device. Each deployment creates a transaction record, which includes details of the deployment.

For detailed information about this API, go to Deployments API.