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 host-enc-specs API

HostEncSpecController API /host-enc-specs/

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

Tagged areas include host-enc-specs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 6 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.

4 operations 2 paths 6 schemas 1 DELETE2 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 host-enc-specs 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 4

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

host-enc-specs 4

HostEncSpecController API /host-enc-specs/

GET
/host-enc-specs/
List host enclosure specs
ListHostEncSpecs 4 params → 200500
POST
/host-enc-specs/
Create a host enclosure spec
CreateHostEncSpec 1 param → 201400409500
GET
/host-enc-specs/{spec_id}
Get host enclosure spec
GetHostEncSpec 1 param → 200500
DELETE
/host-enc-specs/{spec_id}
Delete a host enclosure spec
DeleteHostEncSpec 1 param → 204404409500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are HostEncSpec (6 properties), Enclosure (5 properties), HostEncSpecCreateReq_HostEncSpec (3 properties), HostEncSpecCreateReq (1 property). Each schema is shown below with its type and property counts.

HostEncSpecsResp
object
1 property 1 required
Enclosure
object
Enclosure defines enclosure specification
5 properties
HostEncSpec
object
HostEncSpec defines host enclosure specification
6 properties
HostEncSpecCreateReq_HostEncSpec
object
3 properties 3 required
HostEncSpecResp
object
1 property 1 required
HostEncSpecCreateReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-host-enc-specs-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