SX Storage Exchange

API Overview

SX Storage Exchange provides an S3-compatible REST API for object storage operations. All endpoints require authentication via API key or OAuth2 token.

Authorization: Bearer <your-api-key>
Content-Type: application/json

Endpoints

GET /api/v1/buckets

List all buckets accessible to the authenticated user.

{
  "buckets": [
    {"name": "documents", "created": "2025-11-03T10:00:00Z", "objects": 12480},
    {"name": "backups", "created": "2025-06-15T08:30:00Z", "objects": 342}
  ]
}

PUT /api/v1/objects/{bucket}/{key}

Upload an object. Maximum size: 5 GB per request. For larger files use multipart upload.

GET /api/v1/objects/{bucket}/{key}

Download an object. Supports Range headers for partial downloads.

DELETE /api/v1/objects/{bucket}/{key}

Delete an object. Returns 204 No Content on success.

SDKs

Official client libraries are available for:

• Python: pip install sx-storage
• Go: go get sx.io/client
• JavaScript: npm install @sx/storage-client

The API is also compatible with AWS S3 SDKs. Set the endpoint URL to your SX cluster address.