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

ClientGroupController Operations about client group

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

This API exposes 5 operations across 2 paths, and defines 11 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 11 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 client-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 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.

client-groups 5

ClientGroupController Operations about client group

GET
/client-groups/
List client groups
ListClientGroups 5 params → 200400500
POST
/client-groups/
Create a client group
CreateClientGroup 1 param → 201400500
GET
/client-groups/{client_group_id}
get a client group
GetClientGroup 1 param → 200400404500
DELETE
/client-groups/{client_group_id}
Delete a client
DeleteClientGroup 1 param → 204400404500
PATCH
/client-groups/{client_group_id}
update client group
UpdateClientGroup 2 params → 201400500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ClientGroup (14 properties), ClientGroupCreateReq_ClientGroup (7 properties), Client (6 properties), ClientGroupUpdateReq_ClientGroup (3 properties). Each schema is shown below with its type and property counts.

ClientGroupCreateReq_ClientGroup_Clients_Elt
object
1 property
Client
object
6 properties
ClientGroupUpdateReq
object
1 property
ClientGroupCreateReq_ClientGroup
object
7 properties
ClientGroup
object
ClientGroup defines the access client group
14 properties
ClientGroupResp
object
1 property 1 required
ClientGroupsResp
object
1 property 1 required
ClientGroup_Nestview
object
2 properties
ClientGroupCreateReq
object
1 property
ClientGroupUpdateReq_ClientGroup_Clients_Elt
object
1 property
ClientGroupUpdateReq_ClientGroup
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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