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 Device Actions API

Perform actions on endpoint devices such as isolation and scanning.

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

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

This API exposes 5 operations across 5 paths, and defines 5 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 5 paths 5 schemas 5 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 Device Actions 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 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Device Actions 5

Perform actions on endpoint devices such as isolation and scanning.

POST
/accounts/{accountId}/devices/isolation
Isolate Devices
isolateDevices 1 param body → 200401
POST
/accounts/{accountId}/devices/noisolation
Remove Device Isolation
removeDeviceIsolation 1 param body → 200401
POST
/accounts/{accountId}/devices/uninstall
Uninstall Device Protection
uninstallDeviceProtection 1 param body → 200401
POST
/accounts/{accountId}/devices/action
Perform Device Action
performDeviceAction 1 param body → 200401
POST
/accounts/{accountId}/immediatescan
Start Immediate Scan
startImmediateScan 1 param body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are IsolationRequest (4 properties), ImmediateScanRequest (4 properties), DeviceActionRequest (3 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ImmediateScanRequest
object
4 properties
DeviceActionRequest
object
3 properties
ErrorResponse
object
2 properties
DeviceIdsRequest
object
1 property
IsolationRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watchguard-device-actions-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 Devices API
WatchGuard Licenses API
WatchGuard Operators API
WatchGuard Risk Assessment API
WatchGuard Security Events API