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

Manage WatchGuard Cloud operator users.

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

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

This API exposes 5 operations across 4 paths, and defines 7 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 4 paths 7 schemas 2 GET1 PATCH2 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 Operators 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 4 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Operators 5

Manage WatchGuard Cloud operator users.

POST
/platform/operator-mgmt/v1/operators
Create Operators
createOperators body → 200400401
PATCH
/platform/operator-mgmt/v1/operators
Update Operators
updateOperators body → 200401
POST
/platform/operator-mgmt/v1/DeleteOperators
Delete Operators
deleteOperators body → 200401
GET
/platform/operator-mgmt/v1/TransactionStatus
Get Operator Transaction Status
getOperatorTransactionStatus 1 param → 200401
GET
/platform/operator-mgmt/v1/OperatorsByAccountId
Get Operators by Account
getOperatorsByAccount 1 param → 200401

Schemas 7

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

UpdateOperatorRequest
object
6 properties 2 required
OperatorTransactionResponse
object
3 properties
DeleteOperatorRequest
object
2 properties 2 required
OperatorListResponse
object
2 properties
ErrorResponse
object
3 properties
TransactionStatusResponse
object
2 properties
CreateOperatorRequest
object
8 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watchguard-operators-api-openapi.yml Raw ↑

Other APIs WatchGuard publishes across the network.

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