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

NFSGatewayController provides API for object storage nfs gateway

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

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

12 operations 5 paths 22 schemas 2 DELETE5 GET2 PATCH1 POST2 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 nfs-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 12

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

nfs-gateways 12

NFSGatewayController provides API for object storage nfs gateway

GET
/nfs-gateways/
List all nfs gateways
ListNFSGateways 4 params → 200500
POST
/nfs-gateways/
create nfs gateway
CreateNFSGateway 1 param → 202400500
GET
/nfs-gateways/{gateway_id}
show nfs gateway
GetNFSGateway 1 param → 200500
PUT
/nfs-gateways/{gateway_id}
start/stop nfs gateway
DoNFSGateway 3 params → 202400500
DELETE
/nfs-gateways/{gateway_id}
delete nfs gateway
DeleteNFSGateway 2 params → 202500
PATCH
/nfs-gateways/{gateway_id}
update nfs gateway
UpdateNFSGateway 2 params → 200400500
GET
/nfs-gateways/{gateway_id}/buckets
List nfs gateway bucket maps
ListNFSGatewayBucketMaps 3 params → 200400500
GET
/nfs-gateways/{gateway_id}/buckets/{bucket_id}
get nfs gateway bucket map
GetNFSGatewayBucketMap 2 params → 200400404500
PUT
/nfs-gateways/{gateway_id}/buckets/{bucket_id}
add bucket to nfs gateway
CreateNFSGatewayBucketMap 2 params → 202400500
DELETE
/nfs-gateways/{gateway_id}/buckets/{bucket_id}
remove bucket from nfs gateway
DeleteNFSGatewayBucketMap 3 params → 202400500
PATCH
/nfs-gateways/{gateway_id}/buckets/{bucket_id}
update nfs gateway bucket
UpdateNFSGatewayBucketMap 4 params → 200202400500
GET
/nfs-gateways/{gateway_id}/samples
Get nfs gateway's samples
GetNFSGatewaySamples 4 params → 200404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are NFSGateway (13 properties), NFSGatewayBucketMap (10 properties), NFSGatewayStat (9 properties), NFSGatewayCreateReq_NFSGateway (5 properties). Each schema is shown below with its type and property counts.

NFSGatewayCreateReq
object
1 property 1 required
ObjectStorageBucket_Nestview_lifecycle
object
3 properties
NFSGatewayBucketMapUpdateReq
object
1 property 1 required
NFSGatewayActionReq_NFSGateway
object
1 property 1 required
NFSGatewaySamplesResp
object
1 property 1 required
NFSGatewayRecord
NFSGatewayRecord combine NFSGateway and NFSGatewayStat as API response
ObjectStorageKey_Nestview
object
1 property
Host_Nestview
object
3 properties 1 required
NFSGatewayBucketMapResp
object
1 property 1 required
NFSGateway
object
NFSGateway defines nfs gateway @grpc-models-proto
13 properties
NFSGatewayBucketMapUpdateReq_NFSGatewayBucketMap
object
1 property
NFSGatewayActionReq
object
1 property 1 required
NFSGatewayResp
object
1 property 1 required
NFSGatewayBucketMap
object
NFSGatewayBucketMap defines nfs gateway bucket map @grpc-models-proto
10 properties
NFSGatewayCreateReq_NFSGateway
object
5 properties 4 required
NFSGatewayUpdateReq_NFSGateway
object
2 properties
NFSGatewayStat
object
NFSGatewayStat defines nfs gateway stat
9 properties
NFSGatewayBucketMapsResp
object
1 property 1 required
ObjectStorageBucket_Nestview
object
3 properties
NFSGatewaysResp
object
1 property 1 required
NFSGateway_Nestview
object
2 properties
NFSGatewayUpdateReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-nfs-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