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

MappingGroupController Operations able mapping groups

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

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

8 operations 4 paths 12 schemas 2 DELETE2 GET2 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 mapping-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 8

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

mapping-groups 8

MappingGroupController Operations able mapping groups

GET
/mapping-groups/
List mapping groups
ListMappingGroups 4 params → 200400500
POST
/mapping-groups/
create a mapping group in access path
CreateMappingGroup 1 param → 200202400404500
GET
/mapping-groups/{mapping_group_id}
Get mapping group by id
GetMappingGroup 1 param → 200400500
DELETE
/mapping-groups/{mapping_group_id}
Delete mapping group
DeleteMappingGroup 2 params → 202400404500
PATCH
/mapping-groups/{mapping_group_id}
update mapping group
UpdateMappingGroup 2 params → 200202400404500
POST
/mapping-groups/{mapping_group_id}/block-volumes
add volumes to mapping group
AddVolumes 2 params → 200202400404500
DELETE
/mapping-groups/{mapping_group_id}/block-volumes
remove volumes from mapping group
RemoveVolumes 3 params → 202400404500
PATCH
/mapping-groups/{mapping_group_id}/client-group
update client group in mapping group
UpdateMappingGroupClientGroup 2 params → 200202400404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are MappingGroup (6 properties), MappingGroupReq (3 properties), AccessPath_Nestview (2 properties), ClientGroup_Nestview (2 properties). Each schema is shown below with its type and property counts.

MappingGroupResp
object
1 property 1 required
MappingGroupReq
object
3 properties
MappingGroupsResp
object
1 property 1 required
MappingGroup
object
MappingGroup defines the mapping group of volumes and client groups
6 properties
MappingGroupAddVolumesReq
object
1 property 1 required
MappingGroupRemoveVolumesReq
object
1 property 1 required
AccessPath_Nestview
object
2 properties
MappingGroupUpdateReq_MappingGroup
object
1 property
MappingGroupCreateReq
object
1 property 1 required
ClientGroup_Nestview
object
2 properties
MappingGroupUpdateReq
object
1 property 1 required
MappingGroupUpdateClientGroupReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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