# XSKY

> XSKY (XSKY Data Technology, 星辰天合) is a Beijing-based software-defined storage vendor serving nearly 2,000 large government and enterprise institutions, ranked first in China's object-storage software market. Its distributed storage products — XEUS unified storage, XEBS block storage, XEOS object storage, XGFS file storage, and the XEDP unified data platform — are managed through XMS, the platform's REST controller API, published as a Swagger 2.0 contract with official Go and Python clients.

The XMS API is deployed on-premises with each XSKY SDS cluster; requests are authenticated with the Xms-Auth-Token header (or a token query parameter) and are relative to https://<xms-controller>/v1. The contract covers 585 operations across 124 resource groups: clusters, hosts, disks, OSDs, pools, block volumes and snapshots, object-storage users and buckets, file systems and quotas, NFS/iSCSI/S3 gateways, alerts, and access tokens.

## APIs

- [XSKY XMS API (Go SDK + Swagger contract)](https://github.com/xsky-storage/go-sdk): Official Go client generated from the XMS Swagger 2.0 spec; per-endpoint docs in the docs/ directory
- [XMS Swagger 2.0 spec (verbatim)](https://raw.githubusercontent.com/api-evangelist/xsky/refs/heads/main/openapi/xsky-xms-swagger-original.yaml): API version SDS_4.2.000.0.200302

## SDKs and tools

- [go-sdk](https://github.com/xsky-storage/go-sdk): Official Go client for the XMS API
- [xms-client on PyPI](https://pypi.org/project/xms-client/): Official Python client for the XMS API
- [sds-formation](https://github.com/xsky-storage/sds-formation): Template-driven (CloudFormation-style) provisioning tool for XSKY storage resources
- [xsky-zabbix](https://github.com/xsky-storage/xsky-zabbix): Zabbix monitoring templates for XSKY SDS
- [xsky-csi-driver](https://github.com/xsky-storage/xsky-csi-driver): Kubernetes CSI driver documentation

## Docs

- [XSKY website (English)](https://www.xsky.com/en/)
- [Support portal](https://www.xsky.com/supports/)
- [Product lifecycle (EOL/EOS policy)](https://www.xsky.com/supports/product-lifecycle)
- [News and blog](https://www.xsky.com/en/about/news/)
- [Privacy policy](https://www.xsky.com/en/privacy/)

## Optional

- [API Evangelist profile artifacts](https://github.com/api-evangelist/xsky): authentication, conventions, error catalog, data model, MCP candidate tools, and agent skills derived from the XMS contract