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 block-volume-groups API

VolumeGroupController Operations about volume group

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

This API exposes 7 operations across 3 paths, and defines 10 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.

7 operations 3 paths 10 schemas 2 DELETE2 GET1 PATCH1 POST1 PUT

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 block-volume-groups 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 7

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

block-volume-groups 7

VolumeGroupController Operations about volume group

GET
/block-volume-groups/
List block volume groups
ListBlockVolumeGroups 4 params → 200400500
POST
/block-volume-groups/
Create block volume group
CreateBlockVolumeGroup 1 param → 200400500
GET
/block-volume-groups/{block_volume_group_id}
get a block volume group
GetBlockVolumeGroup 1 param → 200404500
DELETE
/block-volume-groups/{block_volume_group_id}
Delete a block volume group
DeleteBlockVolumeGroup 1 param → 204404500
PATCH
/block-volume-groups/{block_volume_group_id}
Update block volume group
UpdateBlockVolumeGroup 2 params → 200202400500
PUT
/block-volume-groups/{block_volume_group_id}/block-volumes
Add block volume to block volume group
AddBlockVolumeToBlockVolumeGroup 2 params → 200400500
DELETE
/block-volume-groups/{block_volume_group_id}/block-volumes
Remove block volume from block volume group
RemoveBlockVolumeFromBlockVolumeGroup 2 params → 200400500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are VolumeGroup (13 properties), VolumeGroupCreateReq_VolumeGroup (5 properties), VolumeGroupUpdateReq_VolumeGroup (3 properties), VolumeGroupSnapshot_Nestview (2 properties). Each schema is shown below with its type and property counts.

VolumeGroupCreateReq
object
1 property 1 required
VolumeGroupUpdateReq_VolumeGroup
object
3 properties 1 required
VolumeGroupRemoveVolumeReq
object
1 property 1 required
VolumeGroupAddVolumeReq
object
1 property 1 required
VolumeGroupSnapshot_Nestview
object
2 properties
VolumeGroup
object
VolumeGroup defines the model of volume group
13 properties
VolumeGroupsResp
object
1 property
VolumeGroupUpdateReq
object
1 property 1 required
VolumeGroupResp
object
1 property
VolumeGroupCreateReq_VolumeGroup
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-block-volume-groups-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-migration-jobs API
XSKY block-volumes API
XSKY chunks API