Activations API

Version: 1.0.3

Activations API Version History

Download the API specification

Introduction

The Activations API is a RESTful API that you can use to activate WatchGuard hardware devices and software licenses, retrieve activation status, and get a list of recent activations for an account.

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

Get Started

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

The Activations API URL is:

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

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.

Authentication

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

Activate a Device or License

/{v1}/activate

Make a request to this endpoint to activate one or more hardware devices or software licenses.

Request Body

The request body is an array that includes the information required to activate one or more WatchGuard devices or licenses. You can include the information to activate multiple devices or licenses of different types in a single request.

The information you must provide in the request body depends on the type of device or license you want to activate:

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: SN1234567-1234

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: T80 Firebox - Seattle Office

Example request body:

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"friendlyName": "T80 Firebox - Seattle Office"
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: 45D739A7-B26B-4D22-A890-324A34F93D84

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: T80 Firebox - Seattle Office

parentSerialNumber
string

Serial number of the device the 4-hr replacement license is for.

Example: SN1234567-1234

deviceLocation
array

Address of the location where you will deploy the device.

address1
string

First address line of the device location.

Example: 1234 North Street

address2
string

Second address line of the device location.

Example: Suite 1000

city
string

City.

Example: Seattle

stateOrProvince
string

State or province.

Example: WA

country
string

Country.

Example: United States

zipCode
string

Zip or postal code.

Example: 98104

Example request body:

{
"activations": [
	{
	"activationKey": "45D739A7-B26B-4D22-A890-324A34F93D84",
	"deviceDetails": {
		"friendlyName": "T80 Firebox - Seattle Office",
		"parentSerialNumber": "SN1234567-1234",
		"deviceLocation": {
			"address1": "1234 North Street",
			"address2": "Suite 100",
			"city": "Seattle",
			"stateOrProvince": "WA",
			"country": "United States",
			"zipCode": 98104
			}
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: SN1234567-1234

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: Access Point - Seattle Office

initialServiceLicenseKey
string

License key to activate with the device.

For example, when you activate a WatchGuard access point that you manage in WatchGuard Cloud, you must also activate either a WatchGuard Standard Wi-FI or WatchGuard USP Wi-Fi management license.

Example: 783555ee-9f75-4997-83e2-4a81edc49140

Example request body:

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"initialServiceLicenseKey": "783555ee-9f75-4997-83e2-4a81edc49140",
		"friendlyName": "Access Point - Seattle Office"
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: SN1234567-1234

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: Firebox Cloud

instanceId
string

Instance ID (also known as a VM ID) for your Firebox Cloud instance.

Only include this parameter for Firebox Cloud devices. For information on how to find the Instance ID in Azure or AWS, go to Deploy Firebox Cloud on AWS or Deploy Firebox Cloud on Azure in Fireware Help.

Example: I-123456789

Example request body (FireboxV):

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"friendlyName": "FireboxV Small"
		}
	}
]
}

Example request body (Firebox Cloud):

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"friendlyName": "Firebox Cloud Small",
		"instanceId": "I-123456789"
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: 783555ee-9f75-4997-83e2-4a81edc49140

deviceDetails
array

Details of the device to renew a license key for.

parentSerialNumber
string

Device serial number.

Example: SN1234567-1234

Example request body:

{
"activations": [
	{
	"activationKey": "783555ee-9f75-4997-83e2-4a81edc49140",
	"deviceDetails": {
		"parentSerialNumber": "SN1234567-1234"
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: SN1234567-1234

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: M290 Firebox - Seattle Office

tradeIn
array

Details of the trade-in device.

serialNumber
string

Serial number of the competitor device to trade in.

Example: XYZ123234

competitorName
string

Name of the competitor.

Example: Competitor Inc

competitorModel
string

Competitor device model.

Example: Competitor Firewall

Example request body:

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"friendlyName": "M290 Firebox - Seattle Office",
		"tradeIn": {
			"serialNumber": "XYZ123234",
			"competitorName": "Competitor Inc",
			"competitorModel": "Competitor Firewall"
			}
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: SN1234567-1234

deviceDetails
array

Details of the device to activate.

friendlyName
string

Friendly name used to identify the device.

Example: T80 Firebox - Seattle Office

tradeUp
array

Details of the trade-up device.

serialNumber
string

Serial number of the existing device you want to trade-up.

Example: SN7654321-4321

Example request body:

{
"activations": [
	{
	"activationKey": "SN1234567-1234",
	"deviceDetails": {
		"friendlyName": "M270 Firebox - Seattle Office",
		"tradeUp": {
			"serialNumber": "SN7654321-4321"
			}
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: ae6ebb64-0a75-441b-ab18-f454d2b7fd4d

saasDetails
array

Details of the software license to activate.

licenseName
string

Friendly name used to identify the license.

Example: New AuthPoint License

Example request body:

{
"activations": [
	{
	"activationKey": "ae6ebb64-0a75-441b-ab18-f454d2b7fd4d",
		"saasDetails": {
		"licenseName": "New AuthPoint License"
		}
	}
]
}

activations
array

List of activation requests.

activationKey
string

Serial number or license key to activate.

Example: ae6ebb64-0a75-441b-ab18-f454d2b7fd4d

saasDetails
array

Details of the software license to activate.

parentLicenseKey
string

License key of the existing software license to extend or add users to.

Example: f1684f22-ad76-4d1c-a32e-c7f04694cead

licenseName
string

Specifies how to co-term the new software license with the existing license. This can be one of these values:

  • Extend — Extends the expiration date of the existing software license. The user count is updated to match the number of users on the new license.
  • AddUsers — Adds users to the existing software license. The user count is updated to the sum of the users on your current license and your new license.

For more information about co-terming, go to Co-Term AuthPoint Licenses, Co-Term DNSWatchGO Licenses, or Co-Term Endpoint Security Licenses in WatchGuard Help Center.

Example: Extend

Example request body:

{
"activations": [
	{
	"activationKey": "caf2c985-dbe9-4b00-be89-0940d106eb9c",
	"saasDetails": {
		"parentLicenseKey": "f1684f22-ad76-4d1c-a32e-c7f04694cead",
		"extendOrAddUsers": "Extend"
		}
	}
]
}

Example Request

This request activates a Firebox and activates and co-terms a new AuthPoint license with an existing license:

curl -X POST 
	https://api.usa.cloud.watchguard.com/rest/platform/activation/v1/activate 
	-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 '{
		"activations": [
		{
		"activationKey": "SN1234567-1234",
		"deviceDetails": {
			"friendlyName": "T80 Firebox - Seattle Office"
			}
		},
		{
		"activationKey": "caf2c985-dbe9-4b00-be89-0940d106eb9c",
		"saasDetails": {
			"parentLicenseKey": "f1684f22-ad76-4d1c-a32e-c7f04694cead",
			"extendOrAddUsers": "Extend"
			}
		}
		]
	}'

Example Response

If the request succeeds, the API returns a 202 Success status code and data for the items in the request.

{
"activations": [
	{
	"batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	"batchItems": [
		{
		"lineItemId": "58f50ba4-119f-4217-9a4a-0219c6843bcd",
		"tags": {
			"accountId": "ACC-1234567",
			"activationKey": "SN1234567-1234",
			"parentKey": null
			},
		"status": "Queued"
		},
		{
		"lineItemId": "2ae94d32-8516-3648-e6cf-964c3f54ebe2",
		"tags": {
			"accountId": "ACC-1234567",
			"activationKey": "caf2c985-dbe9-4b00-be89-0940d106eb9c",
			"parentKey": null
			},
		"status": "Queued"
		},
		],
	"status": "Processing",
	"statusUrl": "/api/v1/activationbatchstatuses/3fa85f64-5717-4562-b3fc-2c963f66afa6"
	}
]
}

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

Some responses might not include all data.

activations
array

List of API responses for the activations in the activation batch.

batchId
string

Generated activation batch ID used to track activation statuses.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

batchItems
array

List of API responses for each item in the activation batch.

lineItemId
string

ID that identifies a specific line item in an activation batch.

Example: 58f50ba4-119f-4217-9a4a-0219c6843bcd

tags
array

Activation details for the line item.

status
string

Activation status for the line item. This can be one of these values:

  • Created
  • Queued
  • Pending
  • Success
  • Failed

Example: Created

status
string

Status for the activation batch. This can be one of the values:

  • Created
  • Processing
  • Complete
  • CompleteWithErrors

Example: Created

statusUrl
string

Activations API endpoint URL that you can use to check the activation batch status.

For more information, go to Get Activation Status.

Example: /api/v1/activationbatchstatuses/3fa85f64-5717-4562-b3fc-2c963f66afa6

Get Recent Activations

/{v1}/recentactivations

Make a request to this endpoint to return a list of activations for the last 30 days for the account.

Request Parameters

offset
integer

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

The default value is 0.

Example: 20

limit
integer

Specifies the number of records to return in the response.

The default value is 100.

Example: 10

sortBy
string

Specifies how to sort the results in the response. This can be either null or LastModified.

Example: LastModified

Example Request

This request returns the last 10 activations for the account:

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/platform/activation/v1/recentactivations?limit=10&sortBy=LastModified' 
	-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 the list of recent activations for the account:

{
"results": [
	{
	"activationStatus": "Complete",
	"batchId": "4d3844f2-6531-4cb4-ad39-3548711fad8f",
	"created": "2023-07-19T18:55:22.7893734+00:00",
	"lastModified": "2023-07-19T18:55:53.3666857+00:00",
	"lineItemCount": 5,
	"firstLineItem": {
		"lineItemId": "6420da35-0f1d-4048-8c46-7d7516ce7c1b",
		"status": "Success",
		"created": "2023-07-19T18:55:22.7893734+00:00",
		"lastModified": "2023-07-19T18:55:53.3258321+00:00",
		"activationKey": "C6022F3B-C970-4827-AB30-32E882936D23",
		"errors": []
		}
	},
	{
	"activationStatus": "Complete",
	"batchId": "c47f2f23-c9fb-489c-95c2-1028c929272c",
	"created": "2023-07-19T18:39:56.0989013+00:00",
	"lastModified": "2023-07-19T18:40:21.8414606+00:00",
	"lineItemCount": 1,
	"firstLineItem": {
		"lineItemId": "58f50ba4-119f-4217-9a4a-0219c6843bcd",
		"status": "Success",
		"created": "2023-07-19T18:39:56.0989013+00:00",
		"lastModified": "2023-07-19T18:40:21.8809246+00:00",
		"activationKey": "MTUH4J4U0-47BE",
		"errors": []
		}
	},
	{
	"activationStatus": "CompleteWithErrors",
	"batchId": "7532295f-a401-4668-b601-8e8496101d72",
	"created": "2023-07-19T18:35:09.8269335+00:00",
	"lastModified": "2023-07-19T18:35:18.061853+00:00",
	"lineItemCount": 1,
	"firstLineItem": {
		"lineItemId": "85a28b10-b410-49dc-a69c-be09224a4f48",
		"status": "Failed",
		"created": "2023-07-19T18:35:09.8269335+00:00",
		"lastModified": "2023-07-19T18:35:17.9505932+00:00",
		"activationKey": "777777777777",
		"errors": [
			{
			"errorType": "Resource not found. due to : ActivationId has no entitlements: 1234567890-XYZ"
			}
			]
		}
	}
],
"pagination": {
	"offset": 0,
	"limit": 10,
	"totalResults": 3
	}
}

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

Some responses might not include all data.

results
array

List of recent activations.

activationStatus
string

Status for the activation batch. This can be one of the values:

  • Created
  • Processing
  • Complete
  • CompleteWithErrors

Example: Created

batchId
string

Generated activation batch ID.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

created
string

Date when the batch was created.

Example: 2023-07-19T18:40:21.8809246+00:00

lastModified
string

Date when the batch was last modified.

Example: 2023-07-19T18:40:21.8809246+00:00

lineItemCount
integer

Number of items in the activation batch.

Example: 10

firstLineItem
object

Details of the first item in the activation batch.

lineItemId
string

ID that identifies a specific line item in an activation batch.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

status
string

Activation status for the line item. This can be one of these values:

  • Created
  • Queued
  • Pending
  • Success
  • Failed

Example: Created

created
string

Date when the line item was created.

Example: 2023-07-19T18:40:21.8809246+00:00

lastModified
string

Date when the line item was last modified.

Example: 2023-07-19T18:40:21.8809246+00:00

activationKey
string

Serial number or license key to activate.

Example: ae6ebb64-0a75-441b-ab18-f454d2b7fd4d

errors
array

List of activation errors returned by the API.

Get Activation Status

/{v1}/activationbatchstatuses/{batchId}

Make a request to this endpoint to get the status of items in the specified activation batch.

Path Parameters

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

batchId
string
REQUIRED

Activation batch ID to return activation statuses for.

When you submit a request to the /{v1}/activate endpoint, the Activations API generates a batch ID and returns it in the response.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Request Parameters

offset
integer

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

The default value is 0.

Example: 20

limit
integer

Specifies the number of records to return in the response.

The default value is 100.

Example: 10

sortBy
string

Specifies how to sort the results in the response. .

Example: LastModified

Example Request

This request returns activation status for batch ID 3fa85f64-5717-4562-b3fc-2c963f66afa6:

curl -X PUT 
	https://api.usa.cloud.watchguard.com/rest/platform/activation/v1/activationbatchstatuses/3fa85f64-5717-4562-b3fc-2c963f66afa6 
	-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 the status of items in the specified activation batch:

{
"results": [
	{
	"lineItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	"activationKey": "ae6ebb64-0a75-441b-ab18-f454d2b7fd4d",
	"status": "Success",
	"created": "2023-07-19T18:39:56.0989013+00:00",
	"lastModified": "2023-07-19T18:40:21.8809246+00:00",
	"errors": []
	}
],
"pagination": {
	"offset": 0,
	"limit": 0,
	"totalResults": 0
	}
}

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

Some responses might not include all data.

results
array

List of items in the activation batch.

lineItemId
string

ID that identifies a specific line item in an activation batch.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

activationKey
string

Serial number or license key to activate.

Example: ae6ebb64-0a75-441b-ab18-f454d2b7fd4d

status
string

Activation status for the line item. This can be one of these values:

  • Created
  • Queued
  • Pending
  • Success
  • Failed

Example: Created

created
string

Date when the line item was created.

Example: 2023-07-19T18:40:21.8809246+00:00

lastModified
string

Date when the line item was last modified.

Example: 2023-07-19T18:40:21.8809246+00:00

errors
array

List of activation errors returned by the API.