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

HostController Host Management

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

Tagged areas include hosts. 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 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 hosts 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, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

hosts 6

HostController Host Management

GET
/hosts/
List hosts by fileter
ListHosts 12 params → 200400500
POST
/hosts/
check env and install packages
CreateHost 1 param → 202400409500
GET
/hosts/{host_id}
get a host info
GetHost 1 param → 200400404500
DELETE
/hosts/{host_id}
delete host
DeleteHost 2 params → 202400404409500
PATCH
/hosts/{host_id}
update host info
UpdateHost 2 params → 200400404500
GET
/hosts/{host_id}/samples
get a host's samples
GetHostSamples 4 params → 200400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Host (28 properties), HostStat (26 properties), HostCreateReq_Host (9 properties), HostFcPort (4 properties). Each schema is shown below with its type and property counts.

HostCreateReq
object
1 property
HostCreateReq_Host
object
9 properties 1 required
HostFcPort
object
HostFcPort defines fc port on the host
4 properties
HostsResp
object
1 property 1 required
Host
object
Host defines the installed hosts @grpc-models-proto
28 properties 1 required
Host_Nestview
object
3 properties 1 required
HostSamplesResp
object
1 property 1 required
HostUpdateReq
object
1 property 1 required
HostUpdateReq_Host
object
2 properties
HostResp
object
1 property 1 required
Disk_Nestview
object
3 properties
HostRecord
HostRecord combine Host and HostStatus to let API comfortable
HostStat
object
HostStat define the host statistics
26 properties
ProtectionDomain_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-hosts-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