XSKY alert-rules API
AlertRuleController Operations about alert rule
XSKY alert-rules API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include alert-rules. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 10 operations across 4 paths, and defines 12 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 alert-rules 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 10
Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
AlertRuleController Operations about alert rule
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AlertRule (13 properties), AlertRuleCreateReq_Rule (7 properties), AlertRuleUpdateReq_Rule (3 properties), AlertRuleSchemaResp (2 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.