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 vip-groups API

VIPGroupController API /vip-groups

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

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

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

6 operations 3 paths 8 schemas 1 DELETE2 GET1 PATCH2 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 vip-groups 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 6

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

vip-groups 6

VIPGroupController API /vip-groups

GET
/vip-groups/
List vip groups
ListVIPGroups 4 params → 200
POST
/vip-groups/
Create a vip group
CreateVIPGroup 1 param → 202400409500
GET
/vip-groups/{vip_group_id}
Get a vip group
GetVIPGroup 1 param → 200404500
DELETE
/vip-groups/{vip_group_id}
Delete a vip group
DeleteVIPGroup 1 param → 202404409500
PATCH
/vip-groups/{vip_group_id}
Update a vip group
UpdateVIPGroup 2 params → 202400404409500
POST
/vip-groups/{vip_group_id}:redeploy
Redeploy a vip group
RedeployVIPGroup 1 param → 202404409500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are VIPGroup (10 properties), VIPGroupCreateReq_VIPGroup (5 properties), VIPGroupCreateReq_VIPGroup_VIPs_Elt (3 properties), VIPGroupUpdateReq (1 property). Each schema is shown below with its type and property counts.

VIPGroup
object
VIPGroup contains many vips and associated to a resource.
10 properties
VIPGroupUpdateReq_VIPGroup
object
1 property
VIPGroupCreateReq_VIPGroup
object
5 properties 4 required
VIPGroupCreateReq_VIPGroup_VIPs_Elt
object
3 properties 2 required
VIPGroupCreateReq
object
1 property 1 required
VIPGroupResps
object
1 property 1 required
VIPGroupUpdateReq
object
1 property 1 required
VIPGroupResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-vip-groups-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