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

FSNFSShareController provides API for fs nfs shares

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

This API exposes 7 operations across 5 paths, and defines 16 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 5 paths 16 schemas 1 DELETE2 GET4 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-nfs-shares 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 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

fs-nfs-shares 7

FSNFSShareController provides API for fs nfs shares

GET
/fs-nfs-shares/
List fs nfs sharess
ListFSNFSShares 6 params → 200500
POST
/fs-nfs-shares/
Create fs nfs shares
CreateFSNFSShare 1 param → 202400409500
GET
/fs-nfs-shares/{fs_nfs_share_id}
Get fs nfs shares
GetFSNFSShare 1 param → 200404500
DELETE
/fs-nfs-shares/{fs_nfs_share_id}
delete fs nfs shares
DeleteFSNFSShare 2 params → 202404409500
POST
/fs-nfs-shares/{fs_nfs_share_id}:add-acls
Add fs nfs shares acls
AddFSNFSShareACLs 2 params → 202400404409500
POST
/fs-nfs-shares/{fs_nfs_share_id}:remove-acls
remove fs nfs shares acls
RemoveFSNFSShareACLs 2 params → 202404409500
POST
/fs-nfs-shares/{fs_nfs_share_id}:update-acls
Update fs nfs share acls
UpdateFSNFSShareACLs 2 params → 200202400404409500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are FSNFSShare (10 properties), FSNFSShareACLReq (8 properties), FSNFSShareUpdateACLReq (5 properties), FSGatewayGroup_Nestview (4 properties). Each schema is shown below with its type and property counts.

FSGatewayGroup_Nestview
object
4 properties
FSNFSShareResp
object
1 property 1 required
FSNFSSharesResp
object
1 property 1 required
FSNFSShareUpdateACLsReq
object
1 property 1 required
FSNFSShareAddACLsReq
object
1 property 1 required
FSNFSShareCreateReq
object
1 property 1 required
FSNFSShareRemoveACLsReq
object
1 property 1 required
FSNFSShareRemoveACLsReq_Share
object
1 property 1 required
FSNFSShareCreateReq_Share
object
4 properties 2 required
FSNFSShareUpdateACLReq
object
5 properties
FSNFSShareUpdateACLsReq_Share
object
1 property
FSNFSShareACLReq
object
8 properties
FSNFSShare
object
FSNFSShare defines model of fs nfs share
10 properties
FSFolder_Nestview
object
2 properties
FSNFSShareAddACLsReq_Share
object
1 property 1 required
FSQuotaTree_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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