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

XSKY confs API

ConfController Operations about Config

XSKY confs API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 3 paths, and defines 6 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.

5 operations 3 paths 6 schemas 1 DELETE2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY confs 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 token
  • tokenInQuery — auth by token

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

confs 5

ConfController Operations about Config

PUT
/confs/
set conf item
SetConfItem 1 param → 200400500
GET
/confs/{type}
List conf items
ListConfItems 3 params → 200400404500
PUT
/confs/{type}
set conf items
SetConfItems 2 params → 204400500
GET
/confs/{type}/{key}
get conf item
GetConfItem 2 params → 200400404500
DELETE
/confs/{type}/{key}
delete conf item
DeleteConfItem 2 params → 204400404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ConfItem (4 properties), ConfItemSetReq_ConfItem (3 properties), ConfItemsSetReq (1 property), ConfItemSetReq (1 property). Each schema is shown below with its type and property counts.

ConfItemsResp
object
1 property 1 required
ConfItem
object
ConfItem is a ceph config pair
4 properties
ConfItemResp
object
1 property 1 required
ConfItemSetReq
object
1 property 1 required
ConfItemSetReq_ConfItem
object
3 properties 3 required
ConfItemsSetReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-confs-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY auth API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API