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

LicenseController Operations about Install

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

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

This API exposes 5 operations across 4 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 4 paths 7 schemas 4 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 licenses 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 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

licenses 5

LicenseController Operations about Install

GET
/licenses/
List licenses
ListLicenses 5 params → 200500
POST
/licenses/
Activate product license
RegisterLicense 2 params → 200400500
GET
/licenses/key
get license key file
DownloadLicenseKey → 200404500
GET
/licenses/license
get current active license
GetActiveLicense → 200404500
GET
/licenses/{license_id}
get license
GetLicense 1 param → 200404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are License (15 properties), ProductFeature (4 properties), ProductService (3 properties), ProductInfo (2 properties). Each schema is shown below with its type and property counts.

ProductFeature
object
ProductFeature defines product feature
4 properties
LicensesResp
object
1 property 1 required
ProductService
object
ProductService defines product service
3 properties
ProductInfo
object
ProductInfo defines product info
2 properties
License
object
License is used to manage backend license @grpc-models-proto
15 properties
LicenseResp
object
1 property 1 required
ProductLimits
object
ProductLimits defines product limits

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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