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 Accounts API

Manage WatchGuard Cloud accounts and sub-accounts.

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

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

This API exposes 5 operations across 2 paths, and defines 9 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.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 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 Accounts 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 5

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

Accounts 5

Manage WatchGuard Cloud accounts and sub-accounts.

GET
/platform/accounts/v1/accounts/{accountId}
Get Account Information
getAccount 2 params → 200401404
POST
/platform/accounts/v1/accounts/{accountId}
Create Account
createAccount 1 param body → 200400401
PATCH
/platform/accounts/v1/accounts/{accountId}
Update Account
updateAccount 1 param body → 204400401
DELETE
/platform/accounts/v1/accounts/{accountId}
Delete Account
deleteAccount 2 params → 200401404
GET
/platform/accounts/v1/accounts/{accountId}/children
Get Managed Accounts
getManagedAccounts 8 params → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are AccountInfo (8 properties), CreateAccountRequest (5 properties), ManagedAccount (5 properties), UpdateAccountRequest (4 properties). Each schema is shown below with its type and property counts.

ManagedAccountList
object
2 properties
DeleteAccountResponse
object
1 property
PageControls
object
3 properties
CreateAccountResponse
object
1 property
ErrorResponse
object
3 properties
ManagedAccount
object
5 properties
AccountInfo
object
WatchGuard Cloud account information.
8 properties
UpdateAccountRequest
object
4 properties 4 required
CreateAccountRequest
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watchguard-accounts-api-openapi.yml Raw ↑

Other APIs WatchGuard publishes across the network.

WatchGuard Activations API
WatchGuard Allocations 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