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 os-storage-classes API

OSStorageClassController API /os-storage-classes.

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

Tagged areas include os-storage-classes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

3 operations 2 paths 7 schemas 2 GET1 PATCH

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 os-storage-classes 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 3

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

os-storage-classes 3

OSStorageClassController API /os-storage-classes.

GET
/os-storage-classes/
List os storage classes
ListOSStorageClasses 3 params → 200
GET
/os-storage-classes/{storage_class_id}
Get a os storage class
GetOSStorageClass 1 param → 200404500
PATCH
/os-storage-classes/{storage_class_id}
update storage class
UpdateOSStorageClass 2 params → 200202400404409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ObjectStoragePolicy (15 properties), OSStorageClass (10 properties), OSStorageClassUpdateReq_StorageClass (4 properties), Pool_Nestview (2 properties). Each schema is shown below with its type and property counts.

OSStorageClassResp
object
1 property
OSStorageClassesResp
object
1 property
OSStorageClassUpdateReq_StorageClass
object
4 properties
ObjectStoragePolicy
object
ObjectStoragePolicy is the model of objectstoragepolicy
15 properties
Pool_Nestview
object
2 properties
OSStorageClassUpdateReq
object
1 property
OSStorageClass
object
OSStorageClass is the model of osstorageclass
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-storage-classes-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 block-volumes API