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 os-gateways API

ObjectStorageGatewayController provides API for s3 gateway

XSKY os-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-gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 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.

6 operations 3 paths 12 schemas 1 DELETE3 GET1 POST1 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 os-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 token
  • tokenInQuery — auth by token

Paths & Operations 6

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

os-gateways 6

ObjectStorageGatewayController provides API for s3 gateway

GET
/os-gateways/
List s3 gateways
ListGateways 4 params → 200500
POST
/os-gateways/
Create s3 gateway
CreateGateway 1 param → 202400409500
GET
/os-gateways/{gateway_id}
Get s3 gateway
GetGateway 1 param → 200404500
PUT
/os-gateways/{gateway_id}
Update s3 gateway
UpdateGateway 2 params → 200202400404409500
DELETE
/os-gateways/{gateway_id}
Delete s3 gateway
DeleteGateway 1 param → 202400409500
GET
/os-gateways/{gateway_id}/samples
Get s3 gateway's samples
GetGatewaySamples 4 params → 200404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ObjectStorageGateway (12 properties), ObjectStorageGatewayStat (11 properties), ObjectStorageGatewayCreateReq_Gateway (6 properties), Host_Nestview (3 properties). Each schema is shown below with its type and property counts.

ObjectStorageGatewayStat
object
ObjectStorageGatewayStat is the model of objectstoragegatewaystat
11 properties
ObjectStorageGateway
object
ObjectStorageGateway is the model of objectstoragegateway @grpc-models-proto
12 properties
ObjectStorageGatewayUpdateReq_Gateway
object
1 property
ObjectStorageGatewayResp
object
1 property 1 required
ObjectStorageGatewaysResp
object
1 property 1 required
ObjectStorageGatewayCreateReq_Gateway
object
6 properties 3 required
ObjectStorageGatewayRecord
ObjectStorageGatewayRecord combine ObjectStorageGateway and ObjectStorageGatewayStat as API response
Host_Nestview
object
3 properties 1 required
ObjectStorageGatewayCreateReq
object
1 property
ObjectStorageZone_Nestview
object
2 properties
ObjectStorageGatewayUpdateReq
object
1 property
ObjectStorageGatewaySamplesResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-gateways-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