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 access-paths API

AccessPathController Operations able access paths

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

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

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

access-paths 5

AccessPathController Operations able access paths

GET
/access-paths/
List access paths
ListAccessPaths 5 params → 200400500
POST
/access-paths/
Create an access path
CreateAccessPath 1 param → 200202400500
GET
/access-paths/{access_path_id}
Get access path by id
GetAccessPath 1 param → 200400500
DELETE
/access-paths/{access_path_id}
Delete access path
DeleteAccessPath 1 param → 202400404500
PATCH
/access-paths/{access_path_id}
update access path
UpdateAccessPath 2 params → 200202400404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are AccessPath (17 properties), AccessPathCreateReq_AccessPath (9 properties), AccessPathUpdateReq_AccessPath (5 properties), MappingGroupReq (3 properties). Each schema is shown below with its type and property counts.

AccessPathCreateReq_AccessPath
object
9 properties
MappingGroupReq
object
3 properties
AccessPath
object
AccessPath defines access path
17 properties
AccessPathsResp
object
1 property 1 required
AccessPathCreateReq
object
1 property
AccessPathUpdateReq
object
1 property 1 required
AccessPathUpdateReq_AccessPath
object
5 properties
AccessPathResp
object
1 property 1 required
ProtectionDomain_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-access-paths-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

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
XSKY chunks API