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

OSExternalStorageClassController API /os-extertal-storage-classes.

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

This API exposes 5 operations across 2 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.

5 operations 2 paths 10 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 os-external-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 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.

os-external-storage-classes 5

OSExternalStorageClassController API /os-extertal-storage-classes.

GET
/os-external-storage-classes/
List os external storage classes
ListOSExternalStorageClasses 4 params → 200500
POST
/os-external-storage-classes/
Create os external storage class
CreateExternalStorageClass 1 param → 202400409500
GET
/os-external-storage-classes/{external_storage_class_id}
Get a os external storage class
GetOSExternalStorageClass 1 param → 200404500
DELETE
/os-external-storage-classes/{external_storage_class_id}
Delete an os external storage class
DeleteOSExternalStorageClass 1 param → 202404409500
PATCH
/os-external-storage-classes/{external_storage_class_id}
update os external storage class
UpdateOSExternalStorageClass 2 params → 200202400404409500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are OSExternalStorageClass (11 properties), OSExternalStoragePlatform (10 properties), OSExternalStoragePlatformInfo (7 properties), OSExternalStorageClassUpdateReq_ExternalStorageClass (4 properties). Each schema is shown below with its type and property counts.

OSExternalStorageClassUpdateReq
object
1 property
SliceStringField
array
A slice string field.
OSExternalStorageClassesResp
object
1 property
OSExternalStoragePlatformInfo
object
OSExternalStoragePlatformInfo used for update os external storage class
7 properties
OSExternalStorageClassResp
object
1 property
OSExternalStorageClassCreateReq
object
1 property
OSExternalStorageBucketInfo
object
OSExternalStorageBucketInfo contains bucket info of external storage platform
2 properties 2 required
OSExternalStorageClassUpdateReq_ExternalStorageClass
object
4 properties
OSExternalStoragePlatform
object
OSExternalStoragePlatform is the model of osexternalstorageplatform +X:model:generate;withdetailed;orderby=ID
10 properties
OSExternalStorageClass
object
OSExternalStorageClass is the model of os external storage class +X:model:generate;plur=OSExternalStorageClasses;withdetailed
11 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-external-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