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

CloudInstanceController Cloud Instance Management

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

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

3 operations 3 paths 8 schemas 3 GET

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-instances 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 3

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

cloud-instances 3

CloudInstanceController Cloud Instance Management

GET
/cloud-instances/
List cloud instances
ListCloudInstances 5 params → 200500
GET
/cloud-instances/{cloud_instance_id}
Get a cloud instance
GetCloudInstance 1 param → 200404500
GET
/cloud-instances/{cloud_instance_id}/samples
get a cloud instance's Samples
GetCloudInstanceSamples 4 params → 200400404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CloudInstance (12 properties), CloudInstanceStat (9 properties), CloudPlatform_Nestview (3 properties), CloudDatacenter_Nestview (2 properties). Each schema is shown below with its type and property counts.

CloudInstanceResp
object
1 property
CloudInstance
object
CloudInstance defines instances of the cloud platform
12 properties
CloudInstanceStat
object
CloudInstanceStat represents the monitoring metrics of a cloud instance
9 properties
CloudInstanceSamplesResp
object
1 property
CloudInstancesResp
object
1 property
CloudDatacenter_Nestview
object
2 properties
CloudPlatform_Nestview
object
3 properties
CloudInstanceRecord
CloudInstanceRecord combine CloudInstance and CloudInstanceStat as API response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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