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

ObjectStorageZoneController API /os-zones

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

This API exposes 6 operations across 3 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.

6 operations 3 paths 14 schemas 1 DELETE3 GET2 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-zones 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 6

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

os-zones 6

ObjectStorageZoneController API /os-zones

GET
/os-zones/
List object storage zones
ListObjectStorageZones 7 params → 200400500
POST
/os-zones/
Create a object storage zone
CreateObjectStorageZone 1 param → 202400409500
GET
/os-zones/{zone_uuid}
Get object storage zone
GetObjectStorageZone 1 param → 200400404500
POST
/os-zones/{zone_uuid}
update os zone pairs
UpdateOSZonesClockDiff 2 params → 200400409500
DELETE
/os-zones/{zone_uuid}
Delete a object storage zone
DeleteObjectStorageZone 2 params → 202400403404500
GET
/os-zones/{zone_uuid}/samples
get an object storage zone's Samples
GetObjectStorageZoneSamples 4 params → 200400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ObjectStorageZone (22 properties), ObjectStorageZoneStat (7 properties), RemoteCluster_Nestview (4 properties), ObjectStorageZoneCreateReq_Zone (3 properties). Each schema is shown below with its type and property counts.

ObjectStorageZoneCreateReq
object
1 property
RemoteCluster_Nestview
object
4 properties
S3LoadBalancerGroup_Nestview
object
3 properties
ObjectStorageZoneResp
object
1 property
ObjectStorageZonesRecordResp
object
1 property
ObjectStorageZoneCreateReq_Zone
object
3 properties 2 required
OSZonePairsUpdateReq
object
1 property
ObjectStorageZoneRecordResp
object
1 property
ObjectStorageZone
object
ObjectStorageZone is the model of objectstoragezone
22 properties
ObjectStorageZoneSamplesResp
object
1 property 1 required
ObjectStorageZoneStat
object
ObjectStorageZoneStat contains info of os zone
7 properties
OSZonePairsUpdateReq_Zone_TargetZones_Elt
object
2 properties 2 required
OSZonePairsUpdateReq_Zone
object
1 property
ObjectStorageZoneRecord
ObjectStorageZoneRecord combine ObjectStorageZone and ObjectStorageZoneStat as API response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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