Allocations API

Version: 2.3.0

Introduction

The Allocations API is a RESTful API that you can use to allocate and deallocate hardware and software assets, update existing allocations, and get allocation and inventory details for WatchGuard Cloud accounts that you manage.

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

Get Started

This section describes how to submit requests to the Allocations API.

The Allocations API URL is:

https://{base API URL}/rest/platform/allocation/

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 or v2, as part of the endpoint URI path.

Version 1 of the Allocations API is deprecated. Although version 1 endpoints continue to accept requests, we strongly recommend that you use version 2 of the Allocations API.

Authentication

WatchGuard public APIs use the Open Authorization (OAuth) 2.0 authorization framework for token-based authentication. To use the Allocations 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 Allocations API.

For more information, see Authentication.

Request Headers

You must include this information in the header of each request you make to the Allocations 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).

Allocate an Asset

/{v2}/{accountid}/assets

Make a request to this endpoint to allocate an asset (device or software license) to an account you manage.

In version 2.0.2 and higher of the Allocations API, you cannot use this endpoint to create allocations with an allocation type of mixed.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

Request Body

accountId string REQUIRED	WatchGuard Cloud account ID of the managed account to allocate the asset to. Example: WGC-1-123abc456 or ACC-1234567
productName string REQUIRED	Name of the WatchGuard product to allocate. For Linked to License allocations, this is the core product name. Specify one of these values: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_TIS WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR ThreatSyncPlus_NDR Compliance_Reporting You cannot allocate WatchGuard MDR to delegated tier-1 Subscriber accounts. Example: firebox
allocationType string	Specifies the type of allocation. Specify one of these values: term subscription linked_to_license Required for software products. Not required for hardware devices. Example: term
quantity integer or string	Number of users or endpoints to allocate. Specify a number greater than 0 or specify "unlimited". Required for software products, except those with Linked to License allocations. Example: 25
allocationExpiryType string	Allocation expiration type. Specify one of these values: custom — The allocation expires on the date you specify in the `allocationExpiryDate` parameter. never — The allocation never expires. Not applicable to subscription and mixed allocations for software products. Example: custom
allocationExpiryDate string	Allocation expiration date. Required if `allocationExpiryType` is custom, otherwise optional. Example: 2023-12-31
modules array	Allocation details for WatchGuard Endpoint Security modules.
WES_Module_Advanced_Reporting_Tool object	Allocation details for Advanced Reporting Tool.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Patch_Management object	Allocation details for Patch Management.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Full_Encryption object	Allocation details for Full Encryption.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Data_Control object	Allocation details for Data Control.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_SIEM_Feeder object	Allocation details for SIEMFeeder.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_MDR object	Allocation details for WatchGuard MDR. You cannot allocate WatchGuard MDR to delegated tier-1 Subscriber accounts.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
serialOrLicense string	Serial number or license key of the device to allocate. Required if `productName` is firebox, fireboxRetention, or accessPoint, or if `allocationType` is linked_to_license. Example: ABCD123423-4334

Example Request

This request allocates 10 AuthPoint MFA users to account ID WGC-1-123abc456:

curl -X POST 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'
	-d '{
		"accountId": "WGC-1-123abc456",
  		"productName": "AuthPoint_MFA",
  		"allocationType": "term",
  		"allocationExpiryType": "custom",
  		"allocationExpiryDate": "2023-12-31",
  		"quantity": 10
	}'

Example Response

If the allocation succeeds, the API returns a 200 Success status code.

Deallocate an Asset

/{v2}/{accountid}/assets

Make a request to this endpoint to deallocate an asset (device or software license) from an account you manage.

When you deallocate an Endpoint Security product from a managed Subscriber account, any Endpoint Security modules are also deallocated from the account automatically. For a managed Service Provider account, you must deallocate each Endpoint Security product and module individually.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

Request Parameters

accountId string REQUIRED	WatchGuard Cloud account ID of the managed account to deallocate the asset from. Example: WGC-1-123abc456 or ACC-1234567
productName string REQUIRED	Name of the WatchGuard product to deallocate. For Linked to License allocations, specify the name of the core product. Specify one of these values: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_TIS WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
allocationType string	Specifies the type of allocation. Specify one of these values: term subscription mixed linked_to_license Required for software products. Not required for hardware devices. Example: term
serialOrLicense string	Serial number or license key of the device to deallocate. Required if `productName` is firebox, fireboxRetention, or accessPoint, or if `allocationType` is linked_to_license. Example: ABCD123423-4334

Example Request

This request deallocates an AuthPoint MFA license from account ID WGC-1-123abc456:

curl -X DELETE 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets?accountId=WGC-1-123abc456&productName=AuthPoint_MFA&allocationType=term' 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'

Example Response

If the deallocation succeeds, the API returns a 204 status code.

Update a Software Allocation

/{v2}/{accountid}/assets/productName/{productName}/allocationType/{allocationType}

Make a request to this endpoint to update an existing allocation for a software product.

To update the allocationExpiryDate, allocationExpiryType, or quantity for the allocation, specify the existing productName and allocationType in the request body.

To update the productName or allocationType for the allocation, specify a new productName or allocationType in the request body. If the allocationType is linked_to_license, then you must also specify the serialOrLicense.

For WatchGuard Endpoint Security products that support modules, when you update an allocation for a managed Subscriber account or your own Service Provider account, you must include module details in the request. For a managed Service Provider account, you can include a single productName or single module to update.

In version 2.0.2 and higher of the Allocations API, you cannot use this endpoint to update allocations with an allocation type of mixed.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

productName

string

REQUIRED

Name of the WatchGuard product:

accessPoint
firebox
fireboxRetention
TDR
AuthPoint_MFA
AuthPoint_TIS
WES_EDR_Core
WES_EPP
WES_EDR
WES_EPDR
WES_AEPDR
WES_Module_Advanced_Reporting_Tool
WES_Module_Data_Control
WES_Module_Full_Encryption
WES_Module_Patch_Management
WES_Module_SIEMFeeder
WES_Module_MDR
ThreatSyncPlus_NDR
Compliance_Reporting

Example: firebox

allocationType
string
REQUIRED

Specifies the type of allocation. Specify one of these values:

term
subscription
mixed
linked_to_license

Example: term

Request Body

accountId string REQUIRED	WatchGuard Cloud account ID of the managed account you want to update an allocation for. Example: WGC-1-123abc456 or ACC-1234567
productName string REQUIRED	Name of the WatchGuard product: AuthPoint_MFA AuthPoint_TIS WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR ThreatSyncPlus_NDR Compliance_Reporting You cannot allocate WatchGuard MDR to delegated tier-1 Subscriber accounts. Example: firebox
allocationType string REQUIRED	Specifies the type of allocation. Specify one of these values: term subscription linked_to_license Example: term
quantity integer or string	Number of users or endpoints to allocate. Specify a number greater than 0 or specify "unlimited". Required for software products. Example: 25
allocationExpiryType string	Allocation expiration type. Specify one of these values: custom — The allocation expires on the date you specify in the `allocationExpiryDate` parameter. never — The allocation never expires. Not applicable to subscription and mixed allocations for software products. Example: custom
allocationExpiryDate string	Allocation expiration date for term allocations. Required if `allocationExpiryType` is custom, otherwise optional. Example: 2023-12-31
serialOrLicense string	For Linked to License allocations, the license key of the linked license. Example: 1232345245345-234234234
modules array	Allocation details for WatchGuard Endpoint Security modules.
WES_Module_Advanced_Reporting_Tool object	Allocation details for Advanced Reporting Tool.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Patch_Management object	Allocation details for Patch Management.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Full_Encryption object	Allocation details for Full Encryption.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_Data_Control object	Allocation details for Data Control.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_SIEM_Feeder object	Allocation details for SIEMFeeder.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25
WES_Module_MDR object	Allocation details for WatchGuard MDR. You cannot allocate WatchGuard MDR to delegated tier-1 Subscriber accounts.
quantity integer REQUIRED	Specify a number of module licenses to allocate. Example: 25

Example Request

This request updates an AuthPoint MFA license allocation for account ID WGC-1-123abc456:

curl -X PUT 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/productName/AuthPoint_MFA/allocationType/term 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'
	-d '{
		"accountId": "WGC-1-123abc456",
  		"productName": "AuthPoint_MFA",
  		"allocationType": "term",
		"allocationExpiryType": "custom",
		"allocationExpiryDate": "2023-10-31",
  		"quantity": 20
	}'

Example Response

If the allocation updates successfully, the API returns a 200 Success status code.

Update a Hardware Allocation

/{v2}/{accountid}/assets/productName/{productName}/serialOrLicense/{serialOrLicense}

Make a request to this endpoint to update an existing allocation for a hardware device.

For hardware devices, you can update the allocationExpiryDate and allocationExpiryType of an existing allocation.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

productName

string

REQUIRED

Name of the WatchGuard product:

accessPoint
firebox

Example: firebox

serialOrLicense
string
REQUIRED

Serial number or license key of the device you want to update the allocation for.

Example: ABCD123423-4334

Request Body

accountId

string

REQUIRED

WatchGuard Cloud account ID of the managed account you want to update an allocation for.

Example: WGC-1-123abc456 or ACC-1234567

allocationExpiryType

string

REQUIRED

Allocation expiration type. Specify one of these values:

custom — The allocation expires on the date you specify in the allocationExpirationDate parameter.
never — The allocation never expires.

Example: custom

allocationExpiryDate

string

Allocation expiration date.

Required if allocationExpiryType is custom, otherwise optional.

Example: 2023-12-31

Example Request

This request updates a Firebox allocation for account ID WGC-1-123abc456:

curl -X PUT 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/productName/firebox/serialOrLicense/ABCD123423-4334 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'
	-d '{
		"accountId": "WGC-1-123abc456",
		"allocationExpiryType": "custom",
		"allocationExpiryDate": "2025-12-31"
	}'

Example Response

If the allocation updates successfully, the API returns a 200 Success status code.

Get an Inventory Summary for a Service Provider

/{v2}/{accountid}/assets/summary/{resourceType}

Make a request to this endpoint to get an inventory summary for a Service Provider account, based on allocation status.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

WatchGuard Cloud account ID of the Service Provider to return allocation information for. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

resourceType

string

REQUIRED

Type of asset to retrieve. Specify one of these values:

accessPoint — Retrieves a list of Wi-Fi access points.
authPoint — Retrieves a list of AuthPoint licenses.
complianceReporting — Retrieves a list of Compliance Reporting licenses.
endPoint — Retrieves a list of WatchGuard Endpoint Security licenses.
firebox — Retrieves a list of Fireboxes.
fireboxRetention — Retrieves a list of Firebox data retention licenses.
threatsyncNdr — Retrieves a list of ThreatSync+ NDR licenses.

Example: firebox

Request Parameters

allocationStatus
string

Allocation status of the assets to return. Specify one of these values:

allocated
unallocated

Unallocated is the default value.

Example: allocated

offset
integer

Specifies the number of records to skip before the API returns results.

The default value is 0.

Supported for devices only.

Example: 10

limit
integer

Specifies the number of records to return.

The default value is -1, which returns all records.

Supported for devices only.

Example: 50

Example Request

This request returns a summary of allocated Fireboxes for account ID ACC-1234567:

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/summary/firebox?allocationStatus=allocated 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'

Example Response

The response includes a list of the requested assets for the account:

{
"data": [
	{
	"accountId": "ACC-1234567",
	"accountName": "ExampleCo",
	"allocationExpiryType": "never",
	"friendlyName": "Seattle_T40",
	"licenseExpiryDate": "2027-11-07",
	"macAddress": "00:11:11:11:11:12",
	"modelName": "T45",
	"productName": "firebox",
	"serialOrLicense": "D0820DF21-0865"
	},
	{
	"accountId": "ACC-1234567",
       "accountName": "ExampleCo",
       "allocationExpiryDate": "2023-03-31",
       "allocationExpiryType": "custom",
       "daysUntilExpiry": 45,
       "friendlyName": "Demo Firebox",
       "licenseExpiryDate": "2023-03-31",
       "macAddress": "00:11:11:11:11:13",
       "modelName": "T85",
       "productName": "firebox",
       "serialOrLicense": "D0820B0FD-63C7"
	}
],
"pageControls": {
        "limit": -1,
        "offset": 0,
        "totalItems": 2
    }
}

Data returned in the response for software products:

Some responses might not include all data.

productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_TIS WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
allocationType string	Specifies the type of allocation. This can be one of these values: term subscription mixed Example: term
allocationExpiryDate string	Allocation expiration date. Example: 2023-12-31
daysUntilExpiry integer	Number of days until the allocation expires. Example: 366
quantityTotal integer	Total quantity of term licenses. Example: 50
quantityAllocated integer	Number of allocated term licenses. Tier-1 and Tier-2 Service Providers do not have `quantityAllocated` for subscription licenses. Example: 20
quantityAvailable integer	Number of term licenses available for allocation. Example: 30
subscriptionTotal string	Total number of subscription licenses. Default value is unlimited. For Tier-2 Service Providers, this can be a number if the allocation is limited (capped). Example: unlimited
usage integer	Total number of users or endpoints used by the account. Example: 5
licenses array	List of available term licenses that can be allocated to managed accounts as Linked to License allocations.
serialOrLicense string	Serial number or license key of the software license for the Linked to License allocation. Example: 8888-123453-11111
licenseExpiryDate string	License expiration date. Example: 12-12-2222
friendlyName string	Friendly name of the license. Example: EDRLicenseCustomer1
quantity integer	Number of available term licenses that can be allocated as Linked to License allocations. Example: 10
modules array	Endpoint Security module information for licenses with modules.
productName string	Endpoint Security module product name. Example: WES_Module_Patch_Management
licenseExpiryDate string	Module license expiration date. Example: 12-12-2222
quantity integer	Module license quantity. Example: 10

Data returned in the response for hardware products:

Some responses might not include all data.

productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_TIS WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
accountId string	WatchGuard Cloud account ID of the Service Provider. You can see your `accountId` on the My Account page in WatchGuard Cloud. Example: WGC-1-123abc456 or ACC-1234567
accountName string	Name of the WatchGuard Cloud account. Example: Example Company
macAddress string	Mac address of the device. Example: 00:11:11:11:11:13
serialOrLicense string	Serial number or license key of the device. Example: ABCD123423-4334
friendlyName string	Friendly name of the device. Example: Seattle_T45
modelName string	Model name of the device. Example: T45
daysUntilExpiry string	Number of days until the allocation expires. Example: 366
allocationExpiryDate string	Allocation expiration date. Example: 2024-12-31
allocationExpiryType string	Allocation expiration type. This can be one of these values: custom — The allocation expires on the date specified in the `allocationExpiryDate` parameter. never — The allocation never expires. Example: custom
licenseExpiryDate string	License expiration date. Example: 2025-12-31

Get a List of Assets Allocated to Managed Accounts

/{v2}/{accountid}/assets/allocations/{resourceType}

Make a request to this endpoint to get a list of assets allocated to the accounts that a Service Provider manages.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

WatchGuard Cloud account ID of the Service Provider to return allocation information for. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

resourceType

string

REQUIRED

Type of asset to retrieve. Specify one of these values:

accessPoint — Retrieves a list of Wi-Fi access points.
authPoint — Retrieves a list of AuthPoint licenses.
complianceReporting — Retrieves a list of Compliance Reporting licenses.
endPoint — Retrieves a list of WatchGuard Endpoint Security licenses.
firebox — Retrieves a list of Fireboxes.
fireboxRetention — Retrieves a list of Firebox data retention licenses.
threatsyncNdr — Retrieves a list of ThreatSync+ NDR licenses.

Example: firebox

Request Parameters

accountType integer REQUIRED	Type of managed account to return allocations for. Specify one of these values: 1 — Managed Service Provider accounts 2 — Managed Subscriber accounts Example: 2
sortBy string	Specifies how to sort results. Specify one of these values: accountName licenseType allocationExpiryDate quantity Example: quantity
sortOrder string	Specifies whether to sort the results in ascending or descending order. The default value is asc. Specify one of these values: asc — Sorts results in ascending order. desc — Sorts results in descending order.
offset integer	Specifies the number of devices or licenses to skip before the API returns results. The default value is 0. Example: 20
limit integer	Specifies the number of results to return. The default value is -1, which returns all results. Example: 10
filterBy string	Filters by account name. If no filter parameter is specified, all records are returned. If a filter is specified, only filtered results are returned. The default behavior is that the request executes without the filter parameter. Example: ExampleCo

Example Request

This request returns a summary of the Fireboxes allocated to Subscriber accounts managed by the Service Provider account ACC-1234567, sorted by account name in ascending order:

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/allocations/firebox?accountType=2&sortBy=accountName&sortOrder=asc 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'

Example Response

The response includes details of the requested assets allocated to the specified accounts:

{
"data": [
	{
	"productName": "firebox",
	"accountId": "WGC-1-123abc456",
	"accountName": "Subscriber1",
	"quantityTotal": 10
	},
	{
	"productName": "firebox",
	"accountId": "WGC-1-123abc4567",
	"accountName": "Subscriber2",
	"quantityTotal": 20
	},
	{
	"accountId": "WGC-1-123abc4568",
	"accountName": "Subscriber3"
	}
],
"pageControls": {
        "limit": -1,
        "offset": 0,
        "totalItems": 3
    }
}

This table shows and describes the data returned in the response:

Some responses might not include all data.

allocationExpiryDate string	Allocation expiration date. Example: 2023-12-31
allocationExpiryType string	Allocation expiration type, either custom or never. Example: custom
productName string	Name of the WatchGuard product. accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_NFR AuthPoint_TIS AuthPoint_TIS_NFR WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR WESS_EPP_NFR WESS_AD_NFR WESS_AD360_NFR WESS_AEPDR_NFR WESS_Module_ART_NFR WESS_Module_PM_NFR WESS_Module_FE_NFR WESS_Module_DC_NFR WESS_Module_SF_NFR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
accountId string	WatchGuard Cloud account ID of the managed account. Example: WGC-1-123abc456
accountName string	WatchGuard Cloud account name of the managed account. Example: Example Company
quantityTotal integer	Total quantity of term licenses. Example: 76
subscriptionTotal string	Total number of subscription licenses. Default value is unlimited. For Tier-2 Service Providers, this can be a number if the allocation is limited (capped). Example: 76
licenseType string	Type of allocation. This can be one of these values: Mixed Subscription Term Linked_to_License Example: Term
usage integer	Total number of users or endpoints used by the account. Example: 5

Get a List of Assets Owned by a Specific Account

/{v2}/{accountid}/assets/licenses/{resourceType}

Make a request to this endpoint to get a list of assets owned by a specific account.

If you are a Service Provider and want to submit this request on behalf of an account that you manage, you must include the audience value that identifies the managed account when you request an access token. For more information, see Authentication.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

WatchGuard Cloud account ID of the account to return assets for. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

resourceType

string

REQUIRED

Type of asset to retrieve. Specify one of these values:

accessPoint — Retrieves a list of Wi-Fi access points.
authPoint — Retrieves a list of AuthPoint licenses.
complianceReporting — Retrieves a list of Compliance Reporting licenses.
endPoint — Retrieves a list of WatchGuard Endpoint Security licenses.
firebox — Retrieves a list of Fireboxes.
fireboxRetention — Retrieves a list of Firebox data retention licenses.
threatsyncNdr — Retrieves a list of ThreatSync+ NDR licenses.

Example: firebox

Request Parameters

offset
integer

Specifies the number of devices or licenses to skip before the API returns results.

The default value is 0.

Example: 20

limit
integer

Specifies the number of results to return.

The default value is -1, which returns all results.

Example: 10

filterBy
string

Filters by friendlyName and serialOrLicense, as well as model for hardware devices.

If no filter parameter is specified, all records are returned. If a filter is specified, only filtered results are returned. The default behavior is that the request executes without the filter parameter.

Example: ExampleCo

Example Request

This request returns a list of Fireboxes owned by account ID ACC-1234567:

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/licenses/firebox 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'

Example Response

The response includes a list of the requested assets for the account:

{
"data": [
	{
	"productName": "firebox",
	"macAddress": "00:11:11:11:11:12",
	"serialOrLicense": "D0820DF21-0865",
	"friendlyName": "Seattle_T40",
	"modelName": "T45",
	"licenseExpiryDate": "2027-11-07"
	},
	{
       "productName": "firebox",
       "macAddress": "00:11:11:11:11:13",
       "serialOrLicense": "D0820B0FD-63C7"
       "friendlyName": "Demo Firebox",
       "modelName": "T85",
       "licenseExpiryDate": "2023-03-31"
	}
	],
"pageControls": {
        "limit": -1,
        "offset": 0,
        "totalItems": 2
    }
}

Data returned in the response for software products:

Some responses might not include all data.

friendlyName string	Friendly name of the license. Example: EDR_License
productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_NFR AuthPoint_TIS AuthPoint_TIS_NFR WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR WESS_EPP_NFR WESS_AD_NFR WESS_AD360_NFR WESS_AEPDR_NFR WESS_Module_ART_NFR WESS_Module_PM_NFR WESS_Module_FE_NFR WESS_Module_DC_NFR WESS_Module_SF_NFR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
licenseType string	Specifies the type of allocation. This can be one of these values: term subscription mixed linked_to_license Example: term
serialOrLicense string	Serial number or license key for the license. Example: ABCD123423-4334
licenseExpiryDate string	Allocation expiration date. Allocation or license? Example: 2023-12-31
daysUntilExpiry integer	Number of days until the allocation expires. Example: 366
quantityTotal integer	Total quantity of term licenses. Example: 50
subscriptionTotal string	Total number of subscription licenses. Default value is unlimited. For Tier-2 Service Providers, this can be a number if the allocation is limited (capped). Example: unlimited

Data returned in the response for hardware products:

Some responses might not include all data.

productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_NFR AuthPoint_TIS AuthPoint_TIS_NFR WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR WESS_EPP_NFR WESS_AD_NFR WESS_AD360_NFR WESS_AEPDR_NFR WESS_Module_ART_NFR WESS_Module_PM_NFR WESS_Module_FE_NFR WESS_Module_DC_NFR WESS_Module_SF_NFR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
macAddress string	Mac address of the device. Example: 00:11:11:11:11:13
serialOrLicense string	Serial number or license key of the device. Example: ABCD123423-4334
friendlyName string	Friendly name of the device. Example: Seattle_T45
modelName string	Model name of the device. Example: T45
licenseExpiryDate string	License expiration date. Example: 2025-12-31

Get a List of Assets Allocated to a Specific Account

/{v2}/{accountid}/assets/assigned/{resourceType}

Make a request to this endpoint to get a list of assets allocated to a specific account.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId

string

REQUIRED

WatchGuard Cloud account ID of the account to return assets for. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: WGC-1-123abc456 or ACC-1234567

resourceType

string

REQUIRED

Type of asset to retrieve. Specify one of these values:

accessPoint — Retrieves a list of Wi-Fi access points.
authPoint — Retrieves a list of AuthPoint licenses.
complianceReporting — Retrieves a list of Compliance Reporting licenses.
endPoint — Retrieves a list of WatchGuard Endpoint Security licenses.
firebox — Retrieves a list of Fireboxes.
fireboxRetention — Retrieves a list of Firebox data retention licenses.
threatsyncNdr — Retrieves a list of ThreatSync+ NDR licenses.

Example: firebox

Request Parameters

offset
integer

Specifies the number of devices or licenses to skip before the API returns results.

The default value is 0.

Example: 20

limit
integer

Specifies the number of results to return.

The default value is -1, which returns all results.

Example: 10

filterBy
string

Filters by friendlyName, serialOrLicense, or model, for hardware devices.

Example: ExampleCo

Example Request

This request returns a list of Fireboxes allocated to account ID ACC-1234567:

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/platform/allocation/v2/ACC-1234567/assets/assigned/firebox 
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: b9RhPixi9TlNjd3P414uwkzU2VWFw1clhS6KNzuL'

Example Response

The response includes a list of the requested assets for the account:

{
"data": [
	{
	"productName": "firebox",
	"macAddress": "00:00:11:11:11:11",
	"serialOrLicense": "123445555-ABCD",
	"friendlyName": "My Device 1",
	"modelName": "M400",
	"licenseExpiryDate": "2027-12-31"
	},
	{
	"productName": "firebox",
	"macAddress": "00:00:11:11:11:22",
	"serialOrLicense": "123445555-EFGH",
	"friendlyName": "My Device 2",
	"modelName": "M400",
	"licenseExpiryDate": "2027-12-31"
	}
	],
"pageControls": {
        "limit": -1,
        "offset": 0,
        "totalItems": 2
    }
}

Data returned in the response for software products:

Some responses might not include all data.

friendlyName string	Friendly name of the license. Example: EDR_License
productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_NFR AuthPoint_TIS AuthPoint_TIS_NFR WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR WESS_EPP_NFR WESS_AD_NFR WESS_AD360_NFR WESS_AEPDR_NFR WESS_Module_ART_NFR WESS_Module_PM_NFR WESS_Module_FE_NFR WESS_Module_DC_NFR WESS_Module_SF_NFR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
licenseType string	Specifies the type of allocation. This can be one of these values: term subscription mixed linked_to_license Example: term
serialOrLicense string	Serial number or license key for the license. Example: ABCD123423-4334
licenseExpiryDate string	Allocation expiration date. Example: 2023-12-31
daysUntilExpiry integer	Number of days until the allocation expires. Example: 366
quantityTotal integer	Total quantity of term licenses. Example: 50
subscriptionTotal string or integer	Total number of subscription licenses. Default value is unlimited. For Tier-2 Service Providers, this can be a number if the allocation is limited (capped). Example: unlimited

Data returned in the response for hardware products:

Some responses might not include all data.

productName string	Name of the WatchGuard product: accessPoint firebox fireboxRetention TDR AuthPoint_MFA AuthPoint_NFR AuthPoint_TIS AuthPoint_TIS_NFR WES_EDR_Core WES_EPP WES_EDR WES_EPDR WES_AEPDR WES_Module_Advanced_Reporting_Tool WES_Module_Data_Control WES_Module_Full_Encryption WES_Module_Patch_Management WES_Module_SIEMFeeder WES_Module_MDR WESS_EPP_NFR WESS_AD_NFR WESS_AD360_NFR WESS_AEPDR_NFR WESS_Module_ART_NFR WESS_Module_PM_NFR WESS_Module_FE_NFR WESS_Module_DC_NFR WESS_Module_SF_NFR ThreatSyncPlus_NDR Compliance_Reporting Example: firebox
macAddress string	Mac address of the device. Example: 00:11:11:11:11:13
serialOrLicense string	Serial number or license key of the device. Example: ABCD123423-4334
friendlyName string	Friendly name of the device. Example: Seattle_T45
modelName string	Model name of the device. Example: T45
licenseExpiryDate string	License expiration date. Example: 2025-12-31