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-group-snapshots API

VolumeGroupSnapshotController Operations about volume group snapshot

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

This API exposes 5 operations across 2 paths, and defines 14 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.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 PATCH1 POST

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-group-snapshots 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 5

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

block-volume-group-snapshots 5

VolumeGroupSnapshotController Operations about volume group snapshot

GET
/block-volume-group-snapshots/
List block volume group snapshots
ListBlockVolumeGroupSnapshots 4 params → 200400500
POST
/block-volume-group-snapshots/
Create block volume group snapshot
CreateBlockVolumeGroupSnapshot 1 param → 200202400500
GET
/block-volume-group-snapshots/{block_volume_group_snapshot_id}
get block volume group snapshot
GetBlockVolumeGroupSnapshot 1 param → 200404500
DELETE
/block-volume-group-snapshots/{block_volume_group_snapshot_id}
Delete a block volume group snapshot
DeleteBlockVolumeGroupSnapshot 1 param → 202204404500
PATCH
/block-volume-group-snapshots/{block_volume_group_snapshot_id}
Update block volume group snapshot
UpdateBlockVolumeGroupSnapshot 2 params → 200400500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Snapshot (20 properties), VolumeGroupSnapshot (9 properties), RemoteCluster_Nestview (4 properties), Volume_Nestview (3 properties). Each schema is shown below with its type and property counts.

VolumeGroupSnapshot
object
VolumeGroupSnapshot defines the model of volume group snapshot
9 properties
RemoteCluster_Nestview
object
4 properties
VolumeGroupSnapshotUpdateReq_VolumeGroupSnapshot
object
2 properties
VolumeGroupSnapshotCreateReq
object
1 property 1 required
VolumeGroupSnapshotUpdateReq
object
1 property 1 required
Pool_Nestview
object
2 properties
VolumeGroupSnapshot_Nestview
object
2 properties
Snapshot
object
Snapshot is the corresponding rbd snapshot
20 properties
VolumeGroupSnapshotResp
object
1 property 1 required
VolumeGroupSnapshotCreateReq_VolumeGroupSnapshot
object
3 properties 3 required
SnapshotResp
object
1 property 1 required
VolumeGroup_Nestview
object
2 properties
VolumeGroupSnapshotsResp
object
1 property 1 required
Volume_Nestview
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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