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

FSFTPShareController provides API for fs ftp share

XSKY fs-ftp-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-ftp-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-ftp-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-ftp-shares 7

FSFTPShareController provides API for fs ftp share

GET
/fs-ftp-shares/
List fs ftp shares
ListFSFTPShares 6 params → 200500
POST
/fs-ftp-shares/
Create fs ftp share
CreateFSFTPShare 1 param → 202400409500
GET
/fs-ftp-shares/{fs_ftp_share_id}
Get fs ftp share
GetFSFTPShare 1 param → 200404500
DELETE
/fs-ftp-shares/{fs_ftp_share_id}
delete fs ftp share
DeleteFSFTPShare 2 params → 202404409500
POST
/fs-ftp-shares/{fs_ftp_share_id}:add-acls
Add fs ftp share acls
AddFSFTPShareACLs 2 params → 202400404409500
POST
/fs-ftp-shares/{fs_ftp_share_id}:remove-acls
remove fs ftp share acls
RemoveFSFTPShareACLs 2 params → 202400404409500
POST
/fs-ftp-shares/{fs_ftp_share_id}:update-acls
Update fs ftp share acls
UpdateFSFTPShareACLs 2 params → 200202400404409500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are FSFTPShareACLReq (12 properties), FSFTPShare (10 properties), FSFTPShareUpdateACLReq (9 properties), FSFTPShareCreateReq_Share (5 properties). Each schema is shown below with its type and property counts.

FSGatewayGroup_Nestview
object
4 properties
FSFTPShareUpdateACLReq
object
9 properties
FSFTPShareCreateReq
object
1 property 1 required
FSFTPShareUpdateACLsReq
object
1 property 1 required
FSFTPShareRemoveACLsReq
object
1 property 1 required
FSFTPShareACLReq
object
12 properties
FSFolder_Nestview
object
2 properties
FSFTPShareAddACLsReq_Share
object
1 property 1 required
FSFTPShareUpdateACLsReq_Share
object
1 property
FSFTPShare
object
FSFTPShare defines model of fs ftp share
10 properties
FSFTPShareAddACLsReq
object
1 property 1 required
FSFTPShareCreateReq_Share
object
5 properties 2 required
FSQuotaTree_Nestview
object
2 properties
FSFTPShareRemoveACLsReq_Share
object
1 property 1 required
FSFTPSharesResp
object
1 property 1 required
FSFTPShareResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-fs-ftp-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