WatchGuard provides public RESTful APIs you can use for integration with WatchGuard products and services. To use a WatchGuard API, you must enable RESTful API access in WatchGuard Cloud.
For more detailed information, go to the WatchGuard API Help.
Your operator role determines what you can see and do in WatchGuard Cloud. You must have Account Administration permissions in the Owner or Administrator role to view or configure this feature. For more information, go to Manage WatchGuard Cloud Operators and Roles.
Enable API Access
When you enable API access, you establish credentials for read-write and read-only API requests and generate an API key, which identifies your account in requests that you make to WatchGuard APIs. WatchGuard Cloud supports API access for both Service Provider and Subscriber accounts. For information on WatchGuard public API usage statistics for your account, go to See API Usage.
To enable API access, you must have the Owner or Administrator operator role.
To enable API access:
- Log in to WatchGuard Cloud.
If you are a Service Provider, from Account Manager, select My Account or a managed account. - Select Administration > Managed Access.
- Click Enable API Access.
-
Specify the readwrite and readonly passwords to use as your API access credentials. Passwords must be at least 12 characters long and include a lowercase letter, uppercase letter, number, and symbol. The password must not include <, >, emojis, or spaces.
The readwrite password and the readonly password must be different.
- Select the I agree to the terms and conditions in the WatchGuard APIs License Agreement check box.
You can click View the WatchGuard APIs License Agreement to review the details of the agreement. - Click Save.
After you enable API access, you see this information:
- Access ID (Read-write) — Specify this ID and the read-write password as the credentials in an API request to generate an API access token that allows read-write access.
- Access ID (Read-only) — Specify this ID and the read-only password as the credentials in an API request to generate an API access token that allows read-only access.
- Authentication API URL — To generate an access token, send a request to URL of this WatchGuard Authentication API endpoint.
- API URL (base) — The base URL for WatchGuard public API requests.
- API Key — Specify this as the value of the
X-API-Keyheader parameter in all requests to WatchGuard public APIs.
The Authentication API URL and API URL (base) depend on your WatchGuard Cloud account data storage region.
WatchGuard public APIs use token-based authentication. In each request to a WatchGuard API you specify an API key, which identifies your account, and an access token, which authorizes API access for a period of time. To get an access token, you send a request to the WatchGuard Authentication API. The access token request must include the base64 encoded read-write API credentials for your account.
For more information about how to make API requests, go to the WatchGuard API Help. For information on WatchGuard public API usage statistics for your account, go to See API Usage.
Change Your API Passwords
To change the API passwords for the API Access IDs:
- In your WatchGuard Cloud Subscriber account, select Administration > Managed Access.
If you are a Service Provider, from Account Manager, select My Account.
- Click Change Passwords.
- Specify new readwrite and readonly passwords.
- Select the I agree to the terms and conditions in the WatchGuard APIs License Agreement check box.
You can click View the WatchGuard APIs License Agreement to review the details of the agreement. - Click Change Passwords.
Revoke API Access
To revoke API access for your WatchGuard Cloud account:
- Log in to your WatchGuard Cloud account.
If you are a Service Provider, from Account Manager, select My Account. - Select Administration > Managed Access.
- Click Revoke Access.