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-client-groups API

FSClientGroupController provides APIs for file storage client group

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

This API exposes 7 operations across 3 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 3 paths 12 schemas 2 DELETE2 GET1 PATCH1 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-client-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 3 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

fs-client-groups 7

FSClientGroupController provides APIs for file storage client group

GET
/fs-client-groups/
List file storage client groups
ListFSClientGroups 5 params → 200500
POST
/fs-client-groups/
Create file storage client group
CreateFSClientGroup 1 param → 201400409500
GET
/fs-client-groups/{fs_client_group_id}
Get file storage client group
GetFSClientGroup 1 param → 200404500
DELETE
/fs-client-groups/{fs_client_group_id}
delete file storage client group
DeleteFSClientGroup 1 param → 204404409500
PATCH
/fs-client-groups/{fs_client_group_id}
Update file storage client group
UpdateFSClientGroup 2 params → 200400404409500
PUT
/fs-client-groups/{fs_client_group_id}/fs-clients
add clients to file storage client group
AddFSClients 2 params → 200400404409500
DELETE
/fs-client-groups/{fs_client_group_id}/fs-clients
remove clients from file storage client group
RemoveFSClients 2 params → 200400404409500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FSClientGroup (7 properties), FSClient_Nestview (2 properties), FSClientGroupCreateReq_ClientGroup (2 properties), FSClientGroupRemoveClientsReq (1 property). Each schema is shown below with its type and property counts.

FSClientGroupAddClientsReq
object
1 property 1 required
FSClientGroupAddClientsReq_ClientGroup
object
1 property 1 required
FSClientGroupUpdateReq
object
1 property 1 required
FSClientGroupUpdateReq_ClientGroup
object
1 property 1 required
FSClientGroupCreateReq_ClientGroup
object
2 properties 2 required
FSClientGroup
object
FSClientGroup defines model of file storage client group
7 properties
FSClientGroupCreateReq
object
1 property 1 required
FSClientGroupRemoveClientsReq
object
1 property 1 required
FSClientGroupsResp
object
1 property 1 required
FSClientGroupRemoveClientsReq_ClientGroup
object
1 property 1 required
FSClient_Nestview
object
2 properties
FSClientGroupResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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