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

OSReplicationZoneController API /os-replication-zones.

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

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

5 operations 3 paths 14 schemas 1 DELETE3 GET1 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-replication-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 5

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

os-replication-zones 5

OSReplicationZoneController API /os-replication-zones.

GET
/os-replication-zones/
List os replication zones
ListOSReplicationZones 5 params → 200
POST
/os-replication-zones/
Create a os replication zone
CreateOSReplicationZone 1 param → 202400409500
GET
/os-replication-zones/{zone_uuid}
Get a os replication zone
GetOSReplicationZone 1 param → 200404500
DELETE
/os-replication-zones/{zone_uuid}
Delete a os replication zone
DeleteOSReplicationZone 1 param → 202400404409500
GET
/os-replication-zones/{zone_uuid}/samples
get an os replication zone's samples
GetOSReplicationZoneSamples 4 params → 200400404500

Schemas 14

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

OSReplicationZone
object
OSReplicationZone defines models of os replication zone.
14 properties
OSReplicationZoneSamplesResp
object
1 property 1 required
RemoteCluster_Nestview
object
4 properties
ObjectStorageBucket_Nestview_lifecycle
object
3 properties
ObjectStorageBucket_Nestview
object
3 properties
OSReplicationZoneResp
object
1 property
OSReplicationZoneRecordResp
object
1 property
OSReplicationZoneCreateReq
object
1 property 1 required
OSReplicationZoneStat
object
OSReplicationZoneStat contains sync stat info of os replication zone
7 properties
OSReplicationZoneCreateReq_OSReplicationZone
object
2 properties 2 required
OSReplicationZoneRecordsResp
object
1 property
ObjectStorageZone_Nestview
object
2 properties
OSReplicationZoneRecord
OSReplicationZoneRecord is used to combine OSReplicationZone and OSReplicationZoneStat
OSRemotePolicy_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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