How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY Block Volumes API

BlockVolumeController Operations about Block

XSKY Block Volumes API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include block-volumes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 15 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version SDS_4.2.000.0.200302.

Requests are made against a single base URL, /v1.

18 operations 15 paths 36 schemas 1 DELETE4 GET1 PATCH12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 Block Volumes 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 18

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

block-volumes 18

BlockVolumeController Operations about Block

GET
/block-volumes/
List block volumes
ListBlockVolumes 14 params → 200400500
POST
/block-volumes/
Create block volume
CreateBlockVolume body → 202400500
GET
/block-volumes/samples
Batch get block volume samples
BatchGetBlockVolumeSamples → 200400404500
GET
/block-volumes/{block_volume_id}
Get block volume
GetBlockVolume 1 param → 200404500
DELETE
/block-volumes/{block_volume_id}
Delete block volume
DeleteBlockVolume 2 params → 202400404500
PATCH
/block-volumes/{block_volume_id}
Update block volume
UpdateBlockVolume 1 param body → 200400404500
GET
/block-volumes/{block_volume_id}/samples
Get block volume samples
GetBlockVolumeSamples 4 params → 200400404500
POST
/block-volumes/{block_volume_id}:migrate
Migrate block volume
MigrateBlockVolume 1 param body → 202400404409500
POST
/block-volumes/{block_volume_id}:rebuild-replication
Rebuild block volume replication
RebuildBlockVolumeReplication 2 params → 202400404409500
POST
/block-volumes/{block_volume_id}:set-backup-protection
Set backup protection
SetBackupProtection 1 param body → 202400404500
POST
/block-volumes/{block_volume_id}:set-crc
Set block volume crc
SetBlockVolumeCrc 1 param body → 200202400404500
POST
/block-volumes/{block_volume_id}:set-replication
Set block volume replication
SetBlockVolumeReplication 1 param body → 202400404409500
POST
/block-volumes/{block_volume_id}:set-snapshot-protection
Set snapshot protection
SetSnapshotProtection 1 param body → 202400404500
POST
/block-volumes/{block_volume_id}:suspend-replication
Suspend block volume replication
SuspendBlockVolumeReplication 1 param → 202400404409500
POST
/block-volumes/{block_volume_id}:unset-backup-protection
Unset backup protection
UnsetBackupProtection 2 params → 202400404500
POST
/block-volumes/{block_volume_id}:unset-crc
Unset block volume crc
UnsetBlockVolumeCrc 1 param body → 200202400404500
POST
/block-volumes/{block_volume_id}:unset-replication
Set block volume replication
postBlockVolumes{blockVolumeId}:unsetReplication 1 param → 202400404409500
POST
/block-volumes/{block_volume_id}:unset-snapshot-protection
Unset snapshot protection
UnsetSnapshotProtection 2 params → 202400404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Volume (54 properties), VolumeCreateReq_Volume (24 properties), VolumeStat (16 properties), Paging (10 properties). Each schema is shown below with its type and property counts.

DpBlockReplicationPolicy_Nestview
object
2 properties
AccessPath_Nestview
object
2 properties
VolumeCrcSetReq_Volume
object
1 property 1 required
CloudPlatform_Nestview
object
3 properties
MultiVolumesSamplesResp
object
1 property
VolumesResp
object
1 property 1 required
DpBlockSnapshotPolicy_Nestview
object
2 properties
TrashResource_Nestview
object
5 properties
VolumeUpdateReq_Volume
object
9 properties
VolumeCreateReq_Volume
object
24 properties 2 required
VolumeCreateReq
object
1 property 1 required
VolumeMigrateReq
object
1 property
RemoteCluster_Nestview
object
4 properties
VolumeQosSpec
object
VolumeQosSpec is a collection of all qos field
4 properties
VolumeSamplesResp
object
1 property 1 required
VolumeFailedTask
object
4 properties
VolumeMigrateReq_Volume
object
2 properties 1 required
VolumeSnapshotProtectionReq_Volume
object
3 properties 1 required
VolumeGroup_Nestview
object
2 properties
Paging
object
Paging defines paging object
10 properties
VolumeCrcSetReq
object
1 property
VolumeBackupProtectionReq_Volume
object
1 property 1 required
VolumeRecord
VolumeRecord defines the response content of volume related API
VolumeStat
object
VolumeStat records volume stat info
16 properties
VolumeSamplesElem
object
3 properties
VolumeSnapshotProtectionReq
object
1 property
Pool_Nestview
object
2 properties
VolumeReplicationSetReq_Volume
object
3 properties 3 required
Snapshot_Nestview
object
2 properties
VolumeIOSize
object
6 properties
VolumeBackupProtectionReq
object
1 property
VolumeUpdateReq
object
1 property 1 required
VolumeNonIOTask
object
5 properties
Volume
object
Volume is the corresponding rbd image @grpc-models-proto
54 properties
VolumeResp
object
1 property 1 required
VolumeReplicationSetReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-block-volumes-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 Chunks API
Where this information came from

This is an independent, third-party profile of XSKY Block Volumes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.