XSKY alert-groups API
AlertGroupController Operations about alert group
XSKY alert-groups 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-groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 7 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-groups 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
AlertGroupController Operations about alert group
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are AlertGroup (4 properties), AlertGroupCreateReq_AlertGroup (3 properties), AlertGroupUpdateReq_AlertGroup (3 properties), AlertGroupResp (1 property). 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.