Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WatchGuard Allocations API

Allocate and deallocate assets to managed accounts.

WatchGuard Allocations API is one of 11 APIs that WatchGuard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Allocations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against 3 base URLs: https://api.usa.cloud.watchguard.com/rest, https://api.eu.cloud.watchguard.com/rest, https://api.apac.cloud.watchguard.com/rest.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Servers
https://api.usa.cloud.watchguard.com/rest
https://api.eu.cloud.watchguard.com/rest
https://api.apac.cloud.watchguard.com/rest
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

WatchGuard Allocations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as WatchGuard-API-Key (apiKeyAuth).

  • bearerAuth — OAuth 2.0 access token obtained from the WatchGuard Authentication API.
  • apiKeyAuth — API key from the WatchGuard Cloud Managed Access page.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Allocations 3

Allocate and deallocate assets to managed accounts.

POST
/platform/allocation/v2/{accountId}/assets
Allocate Asset
allocateAsset 1 param body → 200400401
DELETE
/platform/allocation/v2/{accountId}/assets
Deallocate Asset
deallocateAsset 1 param body → 204401
GET
/platform/allocation/v2/{accountId}/assets/summary/{resourceType}
Get Inventory Summary
getInventorySummary 5 params → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AllocateAssetRequest (6 properties), DeallocateAssetRequest (3 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

AllocateAssetRequest
object
6 properties
ErrorResponse
object
3 properties
DeallocateAssetRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watchguard-allocations-api-openapi.yml Raw ↑

Other APIs WatchGuard publishes across the network.

WatchGuard Accounts API
WatchGuard Activations API
WatchGuard Authorization API
WatchGuard Configurations API
WatchGuard Device Actions API
WatchGuard Devices API
WatchGuard Licenses API
WatchGuard Operators API
WatchGuard Risk Assessment API
WatchGuard Security Events API