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-folders API

FSFolderController provides API for file storage folder

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

This API exposes 11 operations across 7 paths, and defines 26 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.

11 operations 7 paths 26 schemas 2 DELETE3 GET1 PATCH4 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 fs-folders 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 11

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

fs-folders 11

FSFolderController provides API for file storage folder

GET
/fs-folders/
List file storage folders
ListFolders 11 params → 200500
POST
/fs-folders/
Create file storage folder
CreateFolder 1 param → 200202400409500
GET
/fs-folders/{fs_folder_id}
Get file storage folder
GetFolder 1 param → 200404500
DELETE
/fs-folders/{fs_folder_id}
delete file storage folder
DeleteFolder 2 params → 202404409500
PATCH
/fs-folders/{fs_folder_id}
Update file storage folder
UpdateFolder 2 params → 202400404409500
PUT
/fs-folders/{fs_folder_id}/fs-quota-trees
add file storage quota trees
AddFSQuotaTrees 2 params → 202400404409500
DELETE
/fs-folders/{fs_folder_id}/fs-quota-trees
delete fs quota trees from fs folder
RemoveFSQuotaTrees 2 params → 202400404409500
GET
/fs-folders/{fs_folder_id}/samples
get a file storage folder's samples
GetFSFolderSamples 4 params → 200400404500
POST
/fs-folders/{fs_folder_id}:roll-back
roll back file storage folder
RollBackFolder 2 params → 202404409500
POST
/fs-folders/{fs_folder_id}:set-snapshot-protection
Set snapshot protection for a fs folder
SetFSSnapshotProtection 2 params → 202400404409500
POST
/fs-folders/{fs_folder_id}:unset-snapshot-protection
Unset snapshot protection for a fs folder
UnsetFSSnapshotProtection 2 params → 202400404409500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are FSFolder (27 properties), FSGatewayGroup (18 properties), FSFolderStat (10 properties), FSFolderCreateReq_Folder (8 properties). Each schema is shown below with its type and property counts.

FSFolderUpdateReq
object
1 property 1 required
FSFolderCreateReq
object
1 property 1 required
FSFolderAddQuotaTreesReq
object
1 property 1 required
FSFolder
object
FSFolder defines model of file storage folder
27 properties
FSFolderRollBackReq_Folder
object
1 property
FSFolderStat
object
FSFolderStat records file storage folder stat info
10 properties
FSFolderAddQuotaTreesReq_Folder_QuotaTrees_Elt
object
3 properties 1 required
FSFolderUpdateReq_Folder
object
5 properties
AccessPath_Nestview
object
2 properties
FSFolderSamplesResp
object
1 property
FSFolderRemoveQuotaTreesReq_Folder
object
1 property
FSSnapshot_Nestview
object
2 properties
FSFolderCreateReq_Folder
object
8 properties 1 required
FSFolderRemoveQuotaTreesReq
object
1 property 1 required
FSGatewayGroup
object
FSGatewayGroup defines model of file storage gateway group @grpc-models-proto
18 properties
FSFolderAddQuotaTreesReq_Folder
object
1 property 1 required
FSFolderSnapshotProtectionReq_Folder
object
1 property 1 required
FSFolderRollBackReq
object
1 property 1 required
FSFolderSnapshotProtectionReq
object
1 property 1 required
VolumeQosSpec
object
VolumeQosSpec is a collection of all qos field
4 properties
Pool_Nestview
object
2 properties
FSFoldersResp
object
1 property 1 required
FSFolderResp
object
1 property 1 required
FSFolderRecord
FSFolderRecord combine FSFolder and FSFolderStat as API response
Volume_Nestview
object
3 properties
DpFSSnapshotPolicy_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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