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

FSClientController provides APIs for file storage client

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

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

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 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-clients 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 5

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

fs-clients 5

FSClientController provides APIs for file storage client

GET
/fs-clients/
List file storage clients
ListFSClients 6 params → 200500
POST
/fs-clients/
Create file storage client
CreateFSClient 1 param → 201400409500
GET
/fs-clients/{fs_client_id}
Get file storage client
GetFSClient 1 param → 200404500
DELETE
/fs-clients/{fs_client_id}
delete file storage client
DeleteFSClient 1 param → 204404409500
PATCH
/fs-clients/{fs_client_id}
Update file storage client
UpdateFSClient 2 params → 200400404409500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are FSClient (7 properties), FSClientGroup_Nestview (2 properties), FSClientCreateReq_Client (2 properties), FSClientUpdateReq_Client (1 property). Each schema is shown below with its type and property counts.

FSClientsResp
object
1 property 1 required
FSClientUpdateReq
object
1 property 1 required
FSClientCreateReq
object
1 property 1 required
FSClientResp
object
1 property 1 required
FSClientUpdateReq_Client
object
1 property 1 required
FSClient
object
FSClient defines model of file storage client
7 properties
FSClientCreateReq_Client
object
2 properties 2 required
FSClientGroup_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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