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 cloud-platforms API

CloudPlatformController Cloud Platform Management

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

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

This API exposes 6 operations across 3 paths, and defines 8 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 8 schemas 1 DELETE2 GET1 PATCH2 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 cloud-platforms 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, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

cloud-platforms 6

CloudPlatformController Cloud Platform Management

GET
/cloud-platforms/
List cloud platforms
ListCloudPlatforms 2 params → 200500
POST
/cloud-platforms/
Create cloud platform
CreateCloudPlatform 1 param → 202400500
GET
/cloud-platforms/{cloud_platform_id}
Get a cloud platform
GetCloudPlatform 1 param → 200404500
DELETE
/cloud-platforms/{cloud_platform_id}
Delete cloud platform
DeleteCloudPlatform 1 param → 204404500
PATCH
/cloud-platforms/{cloud_platform_id}
Update a cloud platform
UpdateCloudPlatform 2 params → 200400404500
POST
/cloud-platforms/{cloud_platform_id}:sync
Sync a cloud platform
SyncCloudPlatform 1 param → 202404409500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CloudPlatform (15 properties), CloudPlatformCreateReq_Platform (7 properties), CloudExtraProperties (5 properties), CloudPlatformUpdateReq_Platform (4 properties). Each schema is shown below with its type and property counts.

CloudPlatform
object
CloudPlatform defines different cloud platforms
15 properties
CloudPlatformUpdateReq_Platform
object
4 properties
CloudPlatformCreateReq_Platform
object
7 properties
CloudPlatformUpdateReq
object
1 property
CloudPlatformResp
object
1 property
CloudExtraProperties
object
CloudExtraProperties contains extra properties
5 properties
CloudPlatformsResp
object
1 property
CloudPlatformCreateReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-cloud-platforms-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