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

AccessTokenController Manage users

XSKY access-tokens 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-tokens. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

7 operations 4 paths 10 schemas 1 DELETE2 GET1 PATCH3 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-tokens 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 7

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

access-tokens 7

AccessTokenController Manage users

GET
/access-tokens/
List access tokens
ListAccessTokens 5 params → 200403500
POST
/access-tokens/
Create an access token
CreateAccessToken 1 param → 201400403409500
GET
/access-tokens/{access_token_id}
get an access Token
GetAccessToken 1 param → 200403404500
DELETE
/access-tokens/{access_token_id}
delete an access token
DeleteAccessToken 1 param → 204403404500
PATCH
/access-tokens/{access_token_id}
update an access token
UpdateAccessToken 2 params → 200400404500
POST
/access-tokens/{access_token_id}:regenerate
regenereate an access token UUID
RegenerateAccessToken 1 param → 200404409500
POST
/access-tokens:validate
validate an access token
ValidateAccessToken 1 param → 200400403500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AccessToken (8 properties), AccessTokenCreateReq_AccessToken (3 properties), User_Nestview (2 properties), AccessTokenCreateReq (1 property). Each schema is shown below with its type and property counts.

AccessTokenCreateResp
object
1 property 1 required
AccessTokenCreateRecord
AccessTokenCreateRecord defines access token record for creating api response
AccessTokenCreateReq_AccessToken
object
3 properties 2 required
AccessTokenUpdateReq_AccessToken
object
1 property 1 required
AccessTokenCreateReq
object
1 property
AccessTokensResp
object
1 property 1 required
User_Nestview
object
2 properties
AccessTokenResp
object
1 property
AccessTokenUpdateReq
object
1 property
AccessToken
object
AccessToken used for authentication and authorization
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs XSKY publishes across the network.

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