XSKY os-search-gateways API
OSSearchGatewayController provides API for os search gateways
XSKY os-search-gateways API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include os-search-gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, and defines 9 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 os-search-gateways 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 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
OSSearchGatewayController provides API for os search gateways
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are OSSearchGatewayStat (9 properties), OSSearchGateway (8 properties), Host_Nestview (3 properties), Pool_Nestview (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.