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 s3-load-balancer-groups API

S3LoadBalancerGroupController API

XSKY s3-load-balancer-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 s3-load-balancer-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 GET1 PATCH2 POST1 PUT

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 s3-load-balancer-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, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

s3-load-balancer-groups 8

S3LoadBalancerGroupController API

GET
/s3-load-balancer-groups/
List s3 load balancer groups
ListS3LoadBalancerGroups 4 params → 200500
POST
/s3-load-balancer-groups/
Create a s3 load balancer group
CreateS3LoadBalancerGroup 1 param → 202400500
GET
/s3-load-balancer-groups/{group_id}
Get s3 load balancer group
GetS3LoadBalancerGroup 1 param → 200404500
DELETE
/s3-load-balancer-groups/{group_id}
Delete s3 load balancer group
DeleteS3LoadBalancerGroup 2 params → 202400404500
PATCH
/s3-load-balancer-groups/{group_id}
Update a s3 load balancer group
UpdateS3LoadBalancerGroup 2 params → 202400404500
PUT
/s3-load-balancer-groups/{group_id}/s3-load-balancers
add load balancers to group
AddS3LoadBalancersToGroup 2 params → 202400404500
DELETE
/s3-load-balancer-groups/{group_id}/s3-load-balancers
remove load balancers from group
RemoveS3LoadBalancersFromGroup 3 params → 202400404500
POST
/s3-load-balancer-groups/{group_id}:redeploy
Redeploy a s3 load balancer group
RedeployS3LoadBalancerGroup 1 param → 202400404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are S3LoadBalancerGroup (15 properties), S3LoadBalancerGroupCreateReq_Group (10 properties), S3LoadBalancerGroupUpdateReq_Group (9 properties), S3LoadBalancerGroupCreateReq_Group_LoadBalancers_Elt (4 properties). Each schema is shown below with its type and property counts.

S3LoadBalancerGroupCreateReq
object
1 property 1 required
S3LoadBalancerGroup
object
S3LoadBalancerGroup groups s3 load balancer with vips
15 properties
SSLCertificate_Nestview
object
3 properties
S3LoadBalancerGroupUpdateReq_Group
object
9 properties
S3LoadBalancerGroupCreateReq_Group
object
10 properties 2 required
S3LoadBalancerGroupUpdateReq
object
1 property 1 required
S3LoadBalancersAddReq_LoadBalancers_Elt
object
4 properties 2 required
S3LoadBalancersRemoveReq
object
1 property 1 required
S3LoadBalancerGroupsResp
object
1 property 1 required
S3LoadBalancerGroupCreateReq_Group_LoadBalancers_Elt
object
4 properties 2 required
S3LoadBalancerGroupResp
object
1 property 1 required
S3LoadBalancersAddReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-s3-load-balancer-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