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 fs-gateway-groups API

FSGatewayGroupController provides APIs for file storage gateway group

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

This API exposes 7 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.

7 operations 4 paths 12 schemas 1 DELETE2 GET1 PATCH3 POST

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 fs-gateway-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 token
  • tokenInQuery — auth by token

Paths & Operations 7

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

fs-gateway-groups 7

FSGatewayGroupController provides APIs for file storage gateway group

GET
/fs-gateway-groups/
List file storage gateway groups
ListFSGatewayGroups 6 params → 200500
POST
/fs-gateway-groups/
Create file storage gateway group
CreateFSGatewayGroup 1 param → 202400409500
GET
/fs-gateway-groups/{fs_gateway_group_id}
Get file storage gateway group
GetFSGatewayGroup 1 param → 200404500
DELETE
/fs-gateway-groups/{fs_gateway_group_id}
delete file storage gateway group
DeleteFSGatewayGroup 2 params → 202404409500
PATCH
/fs-gateway-groups/{fs_gateway_group_id}
Update file storage gateway group
UpdateFSGatewayGroup 2 params → 200202400404409500
POST
/fs-gateway-groups/{fs_gateway_group_id}:add-gateways
add file storage gateways
AddFSGateways 2 params → 202400404409500
POST
/fs-gateway-groups/{fs_gateway_group_id}:remove-gateways
remove gateways from gateway group
RemoveFSGateways 3 params → 202400404409500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FSGatewayGroup (18 properties), FSGatewayGroupCreateReq_GatewayGroup (10 properties), FSGatewayGroupUpdateReq_GatewayGroup (9 properties), FSGatewayReq (2 properties). Each schema is shown below with its type and property counts.

FSGatewayGroupUpdateReq
object
1 property 1 required
FSGatewayGroupCreateReq_GatewayGroup
object
10 properties 4 required
FSGatewayGroupRemoveGatewaysReq_GatewayGroup
object
1 property 1 required
FSGatewayGroupsResp
object
1 property 1 required
FSGatewayGroup
object
FSGatewayGroup defines model of file storage gateway group @grpc-models-proto
18 properties
FSGatewayGroupResp
object
1 property 1 required
FSGatewayReq
object
2 properties 1 required
FSGatewayGroupUpdateReq_GatewayGroup
object
9 properties
FSGatewayGroupAddGatewaysReq
object
1 property 1 required
FSGatewayGroupCreateReq
object
1 property 1 required
FSGatewayGroupAddGatewaysReq_GatewayGroup
object
1 property 1 required
FSGatewayGroupRemoveGatewaysReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-fs-gateway-groups-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