XSKY os-buckets API
ObjectStorageBucketController provides API for object storage bucket
ObjectStorageBucketController provides API for object storage bucket
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/xsky-os-buckets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: XMS is the controller of distributed storage system
version: SDS_4.2.000.0.200302
title: XMS access-paths Os Buckets API
contact: {}
license:
name: Commercial
servers:
- url: /v1
tags:
- name: os-buckets
description: 'ObjectStorageBucketController provides API for object storage bucket
'
paths:
/os-buckets/:
get:
tags:
- os-buckets
description: List object storage buckets
operationId: ListBuckets
parameters:
- name: limit
in: query
description: paging param
required: false
x-exportParamName: Limit
schema:
type: integer
format: int64
- name: offset
in: query
description: paging param
required: false
x-exportParamName: Offset
schema:
type: integer
format: int64
- name: name
in: query
description: name of object storage buckets
required: false
x-exportParamName: Name
schema:
type: string
- name: os_policy_id
in: query
description: The id of policy object storage buckets belong to
required: false
x-exportParamName: OsPolicyId
schema:
type: integer
format: int64
- name: os_user_id
in: query
description: The id of user object storage buckets belong to
required: false
x-exportParamName: OsUserId
schema:
type: integer
format: int64
- name: replication_uuid
in: query
description: The uuid of replication os buckets belong to
required: false
x-exportParamName: ReplicationUuid
schema:
type: string
- name: virtual
in: query
description: Virtual bucket or not
required: false
x-exportParamName: Virtual
schema:
type: boolean
- name: q
in: query
description: query param of search
required: false
x-exportParamName: Q
schema:
type: string
- name: sort
in: query
description: sort param of search
required: false
x-exportParamName: Sort
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketsResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- os-buckets
description: Create os bucket
operationId: CreateBucket
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketCreateReq'
description: bucket info
required: true
/os-buckets/samples:
get:
tags:
- os-buckets
description: Get samples of multiple object storage buckets
operationId: BatchGetObjectStorageSamples
parameters:
- name: ids
in: query
description: bucket ids
required: true
x-exportParamName: Ids
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MultiObjectStorageBucketsSamplesResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:
get:
tags:
- os-buckets
description: Get object storage bucket
operationId: GetBucket
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- os-buckets
description: delete object storage bucket
operationId: DeleteBucket
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: force
in: query
description: force delete or not
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- os-buckets
description: Update object storage bucket
operationId: UpdateBucket
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketUpdateReq'
description: bucket info
required: true
/os-buckets/{bucket_id}/lifecycle:
put:
tags:
- os-buckets
description: Set object storage lifecycle rules
operationId: SetObjectStorageLifecycleRules
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageLifecycleSetReq'
description: lifecyce rules info
required: true
delete:
tags:
- os-buckets
description: delete object storage lifecycle
operationId: DeleteObjectStorageLifecycle
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}/nfs-clients:
get:
tags:
- os-buckets
description: List nfs clients
operationId: ListObjectStorageBucketNFSClients
parameters:
- name: limit
in: query
description: paging param
required: false
x-exportParamName: Limit
schema:
type: integer
format: int64
- name: offset
in: query
description: paging param
required: false
x-exportParamName: Offset
schema:
type: integer
format: int64
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientsResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- os-buckets
description: create nfs client
operationId: CreateObjectStorageBucketNFSClients
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RawObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/RawObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientsCreateReq'
description: nfs client info
required: true
delete:
tags:
- os-buckets
description: delete nfs clients
operationId: DeleteObjectStorageBucketNFSClients
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RawObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/RawObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientsDeleteReq'
description: nfs client info
required: true
/os-buckets/{bucket_id}/nfs-clients/{client_id}:
get:
tags:
- os-buckets
description: show nfs client
operationId: GetObjectStorageBucketNFSClient
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: client_id
in: path
description: nfs client id
required: true
x-exportParamName: ClientId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- os-buckets
description: update nfs client
operationId: UpdateObjectStorageBucketNFSClient
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: client_id
in: path
description: nfs client id
required: true
x-exportParamName: ClientId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketNFSClientUpdateReq'
description: nfs client info
required: true
/os-buckets/{bucket_id}/samples:
get:
tags:
- os-buckets
description: get an object storage bucket's Samples
operationId: GetObjectStorageBucketSamples
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: duration_begin
in: query
description: duration begin timestamp
required: false
x-exportParamName: DurationBegin
schema:
type: string
- name: duration_end
in: query
description: duration end timestamp
required: false
x-exportParamName: DurationEnd
schema:
type: string
- name: period
in: query
description: samples period
required: false
x-exportParamName: Period
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketSamplesResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:add-custom-labels:
post:
tags:
- os-buckets
description: add object storage bucket custom labels
operationId: AddCustomLabels
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketCustomLabelsAddReq'
description: bucket custom labels info
required: true
/os-buckets/{bucket_id}:add-os-replication-paths:
post:
tags:
- os-buckets
description: add os replication paths for os bucket
operationId: AddOSReplicationPaths
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketAddReplicationPathsReq'
description: replication paths info
required: true
/os-buckets/{bucket_id}:add-os-replication-zones:
post:
tags:
- os-buckets
description: add os replication zones for os bucket
operationId: AddOSReplicationZones
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketAddReplicationZonesReq'
description: replication zones info
required: true
/os-buckets/{bucket_id}:remove-custom-labels:
post:
tags:
- os-buckets
description: remove object storage bucket custom labels
operationId: RemoveCustomLabels
parameters:
- name: bucket_id
in: path
description: object storage bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketCustomLabelsRemoveReq'
description: custom labels info
required: true
/os-buckets/{bucket_id}:remove-os-bucket-loggings:
post:
tags:
- os-buckets
description: Remove os bucket loggings of os bucket
operationId: RemoveOSBucketLoggings
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketRemoveLoggingsReq'
description: os bucket loggings info
required: true
/os-buckets/{bucket_id}:remove-os-replication-paths:
post:
tags:
- os-buckets
description: remove os replication paths for os bucket
operationId: RemoveOSReplicationPaths
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketRemoveReplicationPathsReq'
description: replication paths info
required: true
/os-buckets/{bucket_id}:remove-os-replication-zones:
post:
tags:
- os-buckets
description: remove os replication zones for os bucket
operationId: RemoveOSReplicationZones
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: force
in: query
description: force delete os replication zone even if target zone is dead
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketRemoveReplicationZonesReq'
description: replication zones info
required: true
/os-buckets/{bucket_id}:set-access-logging:
post:
tags:
- os-buckets
description: Set access logging of os bucket
operationId: SetAccessLogging
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketSetAccessLoggingReq'
description: access logging info
required: true
/os-buckets/{bucket_id}:set-bucket-policy:
post:
tags:
- os-buckets
description: set object storage bucket policy
operationId: SetOSBucketPolicy
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketPolicySetReq'
description: bucket policy info
required: true
/os-buckets/{bucket_id}:set-metadata-search:
post:
tags:
- os-buckets
description: set object storage bucket metadata search
operationId: SetMetadataSearch
parameters:
- name: bucket_id
in: path
description: object storage bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketsResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketMetadataSearchSetReq'
description: bucket metadata search info
required: true
/os-buckets/{bucket_id}:suspend-access-logging:
post:
tags:
- os-buckets
description: suspend access logging for os bucket
operationId: SuspendAccessLoggings
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:suspend-os-replication-paths:
post:
tags:
- os-buckets
description: suspend os replication paths for os bucket
operationId: SuspendOSReplicationPaths
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketUpdateReplicationPathsReq'
description: replication paths info
required: true
/os-buckets/{bucket_id}:switch-owner-os-zone:
post:
tags:
- os-buckets
description: Switch owner zone of os bucket
operationId: SwitchOwnerOSZone
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: force
in: query
description: force to switch even if old owner zone is dead
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OSBucketSwitchOwnerOSZoneReq'
description: new owner os zone info
required: true
/os-buckets/{bucket_id}:unset-access-logging:
post:
tags:
- os-buckets
description: Unset access logging of os bucket
operationId: UnsetAccessLogging
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unset-bucket-policy:
post:
tags:
- os-buckets
description: unset object storage bucket policy
operationId: UnsetOSBucketPolicy
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unsuspend-access-logging:
post:
tags:
- os-buckets
description: unsuspend access logging for os bucket
operationId: UnsuspendAccessLogging
parameters:
- name: bucket_id
in: path
description: bucke
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xsky/refs/heads/main/openapi/xsky-os-buckets-api-openapi.yml