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 Security Events API

Retrieve security event data and overviews.

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

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

This API exposes 3 operations across 3 paths, and defines 1 schema. 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 3 paths 1 schemas 3 GET

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 Security Events 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 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Security Events 3

Retrieve security event data and overviews.

GET
/accounts/{accountId}/securityeventcounters/{type}
Get Security Event Counters
getSecurityEventCounters 3 params → 200401
GET
/accounts/{accountId}/securityevents/{type}/export/{period}
Export Security Events
exportSecurityEvents 4 params → 200401
GET
/accounts/{accountId}/securityoverview/{period}
Get Security Overview
getSecurityOverview 2 params → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watchguard-security-events-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 Operators API
WatchGuard Risk Assessment API