APIs and Endpoint Security

Applies To: WatchGuard Advanced EPDR, WatchGuard EPDR, WatchGuard EDR, WatchGuard EPP

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.

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.

Map Your Accounts

You must map your Panda account to your WatchGuard account to use WatchGuard APIs. You can use the account mapper to link your Panda account to your WatchGuard account. For more information, go to Link Your WatchGuard and Panda Accounts.

If you do not have a WatchGuard account or a Panda account, the account mapper can create an account for you.

APIs and API Access

WatchGuard 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. For more information, go to Get Started with WatchGuard APIs.

The Endpoint Security Management API is a RESTful API that you can use to remotely monitor and manage devices that run WatchGuard Endpoint Security products. For more information, go to Endpoint Security Management API.

The Aether Endpoint Security Management API is a RESTful API that you can use to remotely monitor and manage devices that run Panda Aether platform endpoint security products. For more information, go to Aether Endpoint Security Management API.

View WatchGuard Cloud API Account Details

You can view your WatchGuard Cloud account ID and RESTful API information from WatchGuard Cloud. This information can help you with a Support case.

To view your WatchGuard Cloud account ID, from WatchGuard Cloud:

  1. Log in to your WatchGuard Cloud account.
    If you are a Service Provider, from Account Manager, select My Account.
  2. Select Administration > My Account.
    The WatchGuard account ID has this format: ACC-XXXXXX

Screenshot of the My Account page

To view your WatchGuard Cloud RESTful API information, from WatchGuard Cloud:

  1. Log in to your WatchGuard Cloud account.
    If you are a Service Provider, from Account Manager, select My Account.
  2. Select Administration > Managed Access.

Screenshot of the Managed Access page

Provide this information to Support:

Account Identifier

The account identifier has this format: ACC-XXXXXX

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 the 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-Key header parameter in all requests to WatchGuard public APIs.

Read-only password

The read-only password or passphrase that allows access to the device with the status Device Management user account.

Collect Data

When you contact Support, you can also provide this information to help troubleshoot your case.

  • Screenshots of the issue
  • Description of the issue

Related Topics

WatchGuard API Help