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 crypto-keys API

CryptoKeyController API /crypto-keys/

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

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

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

crypto-keys 5

CryptoKeyController API /crypto-keys/

GET
/crypto-keys/
List crypto keys
ListCryptoKeys 4 params → 200500
POST
/crypto-keys/
Create a crypto key
CreateCryptoKey 2 params → 201400500
GET
/crypto-keys/{key_id}
Get a crypto key
GetCryptoKey 1 param → 200404500
PATCH
/crypto-keys/{key_id}
Update a crypto key
UpdateCryptoKey 2 params → 200400404500
GET
/crypto-keys/{key_id}/key
DownloadCryptoKey 2 params → 200404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CryptoKey (6 properties), CryptoKeyUpdateReq (1 property), CryptoKeysResp (1 property), CryptoKeyResp (1 property). Each schema is shown below with its type and property counts.

CryptoKeyUpdateReq_Key
object
1 property
CryptoKeyResp
object
1 property 1 required
CryptoKeysResp
object
1 property 1 required
CryptoKeyUpdateReq
object
1 property
CryptoKey
object
CryptoKey is a crypto key
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-crypto-keys-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