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

BlockSnapshotController Operations about Block Snapshot

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

This API exposes 5 operations across 3 paths, and defines 11 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 3 paths 11 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-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 3 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-snapshots 5

BlockSnapshotController Operations about Block Snapshot

GET
/block-snapshots/
List block snapshots
ListBlockSnapshots 8 params → 200400500
POST
/block-snapshots/
Create block snapshot
CreateBlockSnapshot 1 param → 202400500
GET
/block-snapshots/{block_snapshot_id}
get block snapshot
GetBlockSnapshot 1 param → 200404500
DELETE
/block-snapshots/{snapshot_id}
Delete block snapshot
DeleteBlockSnapshot 1 param → 202404500
PATCH
/block-snapshots/{snapshot_id}
Update block snapshot info
UpdateSnapshot 2 params → 200400404500

Schemas 11

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

SnapshotUpdateReq_Snapshot
object
2 properties
RemoteCluster_Nestview
object
4 properties
SnapshotUpdateReq
object
1 property 1 required
SnapshotsResp
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
SnapshotCreateReq_Snapshot
object
3 properties 3 required
SnapshotResp
object
1 property 1 required
Volume_Nestview
object
3 properties
SnapshotCreateReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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