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 remote-clusters API

RemoteClusterController API /remote-clusters

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

Tagged areas include remote-clusters. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

5 operations 2 paths 7 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 remote-clusters 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.

remote-clusters 5

RemoteClusterController API /remote-clusters

GET
/remote-clusters/
List remote clusters
ListRemoteClusters 5 params → 200400500
POST
/remote-clusters/
Create a remote cluster
CreateRemoteCluster 1 param → 200400409500
GET
/remote-clusters/{cluster_id}
Get remote cluster
GetRemoteCluster 1 param → 200400404500
DELETE
/remote-clusters/{cluster_id}
Delete a remote cluster
DeleteRemoteCluster 1 param → 202204400403404500
PATCH
/remote-clusters/{cluster_id}
Update a remote cluster
UpdateRemoteCluster 2 params → 200400403404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RemoteCluster (14 properties), RemoteClusterUpdateReq_RemoteCluster (2 properties), RemoteClusterCreateReq_RemoteCluster (2 properties), RemoteClusterUpdateReq (1 property). Each schema is shown below with its type and property counts.

RemoteClusterResp
object
1 property
RemoteClustersResp
object
1 property
RemoteClusterCreateReq_RemoteCluster
object
2 properties 2 required
RemoteCluster
object
RemoteCluster remote clusters communicated via public API
14 properties
RemoteClusterUpdateReq_RemoteCluster
object
2 properties 2 required
RemoteClusterCreateReq
object
1 property
RemoteClusterUpdateReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-remote-clusters-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