XSKY alerts API
AlertController Operations about alert
XSKY alerts API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include alerts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.
Requests are made against the base URL https://{xms-controller}/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
XSKY alerts API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Xms-Auth-Token (tokenInHeader).
An API key is passed in the query as token (tokenInQuery).
tokenInHeader— auth by tokentokenInQuery— auth by token
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
AlertController Operations about alert
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Alert (23 properties), ErrorRecord (9 properties), AlertStats (4 properties), Host_Nestview (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from XSKY 12
Other APIs XSKY publishes across the network.